Publish a @sass/types package with the types of the shared JS API (#2639)

Co-authored-by: Natalie Weizenbaum <[email protected]>

Author: stof

.github/workflows/release.yml

@@ -99,6 +99,38 @@ jobs:
       - run: git tag sass-api-${{ steps.sass-api-version.outputs.version }}
       - run: git push --tag
 
+  deploy_sass_types:
+    name: Deploy @sass/types
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+      # Set up .npmrc file to publish to npm
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+          check-latest: true
+          registry-url: 'https://registry.npmjs.org'
+      - name: Get Dart Sass version
+        id: dart-sass-version
+        run: echo "version=${{ github.ref_name }}" | tee --append "$GITHUB_OUTPUT"
+      - name: Check out the language repo
+        uses: actions/checkout@v5
+        with: {repository: sass/sass, path: build/language}
+      - name: Copy types from the language repo
+        run: cp -r build/language/js-api-doc pkg/sass-types/types
+      - name: Copy LICENSE file
+        run: cp LICENSE pkg/sass-types/
+      - name: Set the version of @sass/types
+        run: npm pkg set version='{{ steps.dart-sass-version.outputs.version }}'
+        working-directory: pkg/sass-types/
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: '${{ secrets.NPM_TOKEN }}'
+        working-directory: pkg/sass-types/
+
   deploy_sass_parser:
     name: Deploy sass-parser
     runs-on: ubuntu-latest

CHANGELOG.md

@@ -1,9 +1,15 @@
-## 1.92.2-dev
+## 1.93.0
 
 * Fix a crash when a style rule contains a nested `@import`, and the loaded file
   `@use`s a user-defined module as well as `@include`s a top-level mixin which
   emits top-level declarations.
 
+### JavaScript API
+
+* Release a `@sass/types` package which contains the type annotations used by
+  both the `sass` and `sass-embedded` package without any additional code or
+  dependencies.
+
 ## 1.92.1
 
 * Fix a bug where variable definitions from one imported, forwarded module

pkg/sass-parser/CHANGELOG.md

@@ -1,4 +1,4 @@
-## 0.4.29-dev
+## 0.4.29
 
 * No user-visible changes.
 

pkg/sass-parser/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sass-parser",
-  "version": "0.4.29-dev",
+  "version": "0.4.29",
   "description": "A PostCSS-compatible wrapper of the official Sass parser",
   "repository": "sass/sass",
   "author": "Google Inc.",

pkg/sass-types/README.md

@@ -0,0 +1,6 @@
+# @sass/types
+
+This package is a dual-publish of the [Sass JS API](https://sass-lang.com/documentation/js-api/)
+types. The `sass` and `sass-embedded` packages **still contain types**. This package is for
+users who _only_ need the Sass JS types (such as for `@types/gulp-sass`). It is published
+alongside every release of `sass` and `sass-embedded`, so you can always use the same version.

pkg/sass-types/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@sass/types",
+  "version": "auto",
+  "description": "A standalone types package for the Sass JS API",
+  "repository": "sass/sass",
+  "author": "Google Inc.",
+  "license": "MIT",
+  "exports": {
+    "types": "./types/index.d.ts"
+  },
+  "types": "types/index.d.ts",
+  "files": [
+    "types/**/*.d.ts"
+  ]
+}

pkg/sass_api/CHANGELOG.md

@@ -1,4 +1,4 @@
-## 15.11.1-dev
+## 15.12.0
 
 * No user-visible changes.
 

pkg/sass_api/pubspec.yaml

@@ -2,15 +2,15 @@ name: sass_api
 # Note: Every time we add a new Sass AST node, we need to bump the *major*
 # version because it's a breaking change for anyone who's implementing the
 # visitor interface(s).
-version: 15.11.1-dev
+version: 15.12.0
 description: Additional APIs for Dart Sass.
 homepage: https://github.com/sass/dart-sass
 
 environment:
   sdk: ">=3.6.0 <4.0.0"
 
 dependencies:
-  sass: 1.92.2
+  sass: 1.93.0
 
 dev_dependencies:
   dartdoc: ^8.0.14

pubspec.yaml

@@ -1,5 +1,5 @@
 name: sass
-version: 1.92.2-dev
+version: 1.93.0
 description: A Sass implementation in Dart.
 homepage: https://github.com/sass/dart-sass