Commit Graph

53 Commits

Author SHA1 Message Date
Natalie Weizenbaum
79799ca575 [Interleaved Declarations] Mark as accepted
See #3846
2024-06-18 17:08:12 -07:00
Jennifer Thakar
87699d79b2
Add deprecations.yaml as a single-source-of-truth (#3872)
Instead of having the list of deprecations repeated in several different
places across all of our repos, the new `spec/deprecations.yaml` file
will be the only place we need to update it, with all other uses
generating code based on it.
2024-05-29 14:23:18 -07:00
Natalie Weizenbaum
d3ed8dfc72
[CSS Function/Mixin Prep] Mark as accepted and update spec (#3854) 2024-04-30 21:19:57 +00:00
Natalie Weizenbaum
55514224ca
Clarify that base importer resolution does not require a URL (#3832)
See sass/dart-sass#2208

Co-authored-by: Carlos (Goodwine) <2022649+Goodwine@users.noreply.github.com>
2024-04-11 22:33:39 +00:00
Jennifer Thakar
ede7f25c8e
Integrate the deprecations API into the spec/docs/protocol (#3826) 2024-04-03 14:14:44 -07:00
Natalie Weizenbaum
d0123b2e7d Include extensions in the example docs for Node.js pkg exports (#3808)
See sass/dart-sass#2183
2024-03-27 11:43:24 -07:00
Natalie Weizenbaum
e134f71cae Broaden the the Node.js package importer's notion of "entrypoint" (#3791)
This also updates the spec for `NodePackageImporter` to correctly
document indicate that errors should be thrown during construction.

See sass/dart-sass#2178
2024-03-27 11:43:24 -07:00
なつき
b22ff9dd45 Fix NodePackageImporter version compatibility (#3788)
Co-authored-by: Natalie Weizenbaum <nweiz@google.com>
2024-03-27 11:43:24 -07:00
James Stuckey Weber
336bfd69b2 [Package Importer] Add types and specs (#3728)
Co-authored-by: Jonny Gerig Meyer <jonny@oddbird.net>
2024-03-27 11:43:24 -07:00
James Stuckey Weber
de2dc317c0 [Shared Resources] Add types and specs (#3744)
Co-authored-by: Jonny Gerig Meyer <jonny@oddbird.net>
2024-03-27 11:43:24 -07:00
なつき
0b8a9b84b6 Clarifying performance expectations about sass and sass-embedded (#3716) 2024-03-27 11:43:06 -07:00
Connor Skees
ef2e99db8c Add first class mixins to embedded sass protobuf and JS API (#3674) 2024-03-27 10:55:44 -07:00
Natalie Weizenbaum
058ce05454
[Containing URL] Update the specification (#3688)
See #3247
2023-09-18 23:00:25 +00:00
Goodwine
48f718bf2c
Fix documentation typo in color.d.ts (#3650) 2023-08-08 13:05:27 -07:00
Natalie Weizenbaum
595c7234c9
Document the upcoming change to passing null as alpha (#3644) 2023-08-07 22:07:03 +00:00
Ed Rivas
524790175f
Add JS type definitions for calculations (#3622)
Co-authored-by: Jonny Gerig Meyer <jonny@oddbird.net>
2023-07-19 14:36:23 -07:00
Natalie Weizenbaum
8cbac5b0e5
Fix a reference to a dead link (#3625) 2023-06-30 13:46:06 -07:00
Natalie Weizenbaum
33f881f035
Partially revert "Add JS type defs for calculations (#3605)" (#3619)
This reverts the parts of commit 39915044f6 that modify the official specs. These should only have landed along with implementation updates.
2023-06-20 17:22:15 -07:00
Ed Rivas
39915044f6
Add JS type defs for calculations (#3605)
Co-authored-by: Jonny Gerig Meyer <jonny@oddbird.net>
2023-06-20 15:55:26 -07:00
Natalie Weizenbaum
1f88ea8db4
Update to TypeDoc 0.24 (#3581) 2023-05-18 16:09:10 -07:00
Goodwine
4728f82003
Clarify that compile and compileString accept optional options (#3373) 2022-08-08 16:56:35 -07:00
なつき
38f84212d2
Update documentation for charset option (#3358) 2022-07-18 20:14:43 +00:00
なつき
c1850ac85d
Add charset option to js-api (#3346) 2022-06-29 16:25:21 -07:00
Natalie Weizenbaum
8cbe77da7c
Fix a bug in the custom function example (#3305)
Closes #3304
2022-05-02 14:42:09 -07:00
なつき
12cee2dab9
Fix incorrect documentation for url in StringOptionsWithoutImporter (#3278) 2022-04-11 17:09:26 -07:00
Myles Lewando
ac8d416fe2
📝 Require correct url module in FileImporter doc (#3268) 2022-03-24 15:48:30 -07:00
Christophe Coevoet
f355f602fc
Add the sourceMapIncludeSources option in the new JS API (#3226) 2022-01-14 16:38:28 -08:00
Natalie Weizenbaum
809bc03b48
Fix some incorrect documentation/typings in LegacyPluginThis.options (#3246)
The new documentation/typings reflect the actual behavior of both Node
Sass and Dart Sass.
2022-01-13 18:03:46 -08:00
Natalie Weizenbaum
ade3787da2
Add a type annotation for the top-level NULL field (#3243) 2022-01-11 17:28:10 -08:00
Natalie Weizenbaum
72974e1ec9
Add type annotations for the top-level TRUE and FALSE fields (#3241) 2022-01-07 14:34:44 -08:00
Natalie Weizenbaum
a9aa972e44
Add type annotations for the sass.types.Error class (#3238) 2022-01-05 16:39:32 -08:00
Natalie Weizenbaum
4b48b0e990
Add a type declaration for LegacyPluginThis.options.context (#3236) 2022-01-05 16:08:51 -08:00
Natalie Weizenbaum
b51895ec1d
Make LegacyAsyncFunction type more usable (#3237)
TypeScript requires that a callback type with a rest parameter be
passed a callback with a rest parameter. This makes it awkward to pass
in functions with a known number of parameters, as in
`foo($arg): (value, done) => { /* ... */ }`. This type declaration
makes that easier (although callers still need to explicitly declare a
type for the `done` parameter).
2022-01-05 16:08:41 -08:00
Natalie Weizenbaum
99168e0cbf
Make LegacyFileOptions.data optional (#3215)
If this is mandatory, the compiler will complain if it's not passed,
but it's typed as `never` so it's impossible to pass a valid value.
2021-12-10 21:11:38 +00:00
Natalie Weizenbaum
23278f2c92
Use the URL type from the DOM definitions, not from Node (#3214)
The two aren't quite interchangeable: the Node definition has a few
more fields, which means that URLs created naively with `new URL()`
aren't assignable to that type.
2021-12-10 21:11:27 +00:00
Natalie Weizenbaum
b192519b55
Document the new JS API (#3183) 2021-11-30 23:32:04 +00:00
Natalie Weizenbaum
ebbc52877a
Make the new JS API a bit more idiomatic (#3200)
This takes more advantage of overloads and unions rather than
using factory constructors or methods with different names.
2021-11-30 00:10:42 +00:00
Natalie Weizenbaum
875d7c05bb
Add a code example for Logger.silent (#3192)
See sass/dart-sass#1533
2021-10-26 21:06:38 +00:00
Natalie Weizenbaum
7d3f10de38
Merge pull request #3186 from sass/heads-up
Get rid of explicit heads-up and compatibility HTML
2021-10-11 21:58:47 +00:00
Natalie Weizenbaum
ea3d97b8d6
Replace FileImporterResult with a plain URL (#3180)
Supplying a source map URL doesn't make sense for a file importer, for
two reasons:

1. A canonical `file:` URL is already the recommended source map URL
   because it's always available on the local system.

2. Because a FileImporter doesn't know the fully-resolved canonical
   URL of the file it loads, it doesn't have any way of determining
   what the full source map URL should be anyway.
2021-10-09 01:19:02 +00:00
Natalie Weizenbaum
1047c1a870 Convert explicit compatiblity HTML into a nicer @-tag 2021-10-08 18:12:15 -07:00
Natalie Weizenbaum
77a592d4dc Convert explicit "Heads up" HTML into nicer-looking Markdown
On the Sass site side, we'll detect this markdown and convert it into
our special HTML, but this way it's easier to read and write and more
IDE-friendly.
2021-10-08 16:51:10 -07:00
Natalie Weizenbaum
b72a02550c
Document the logger API (#3177)
Co-authored-by: Awjin Ahn <awjin@google.com>
2021-10-05 22:54:16 +00:00
Natalie Weizenbaum
6fa1678aa2
Rename ImporterResult.css to ImporterResult.contents (#3175)
The name "css" is a bit misleading, since it's usually not going to be
plain CSS.
2021-10-05 20:56:18 +00:00
Natalie Weizenbaum
8776b94818 Merge branch 'legacy-api-docs' of github.com:sass/sass into legacy-api-docs 2021-10-04 19:02:32 -07:00
Natalie Weizenbaum
e066efb790 Code review changes 2021-10-04 19:02:24 -07:00
Natalie Weizenbaum
3e9ef651e1
Apply suggestions from code review
Co-authored-by: Awjin Ahn <awjin@google.com>
2021-10-05 02:02:18 +00:00
Natalie Weizenbaum
6f5552ff8e Document the legacy API and Logger 2021-10-04 15:01:18 -07:00
Natalie Weizenbaum
e0b72c11ba Rename ImporterThis and PluginThis to clearly indicate legacy status 2021-10-04 14:19:14 -07:00
Natalie Weizenbaum
4b4d6c79dd Mark the new API as hidden for now
This will allow us to start rendering the typedoc for the legacy API
rather than needing to write it in ERB.
2021-10-04 13:44:01 -07:00