Add common Sass TypeScript configuration to the analysis package

Author: nex3

.github/dependabot.yml

@@ -1,7 +1,9 @@
 version: 2
 updates:
   - package-ecosystem: "pub"
-    directory: "/"
+    directories:
+      - "/"
+      - "/analysis"
     schedule:
       interval: "weekly"
   - package-ecosystem: "github-actions"
@@ -13,6 +15,7 @@ updates:
   - package-ecosystem: "npm"
     directories:
       - "/"
+      - "/analysis"
       - "/package"
       - "/pkg/sass-parser"
     ignore:

analysis/.eslintrc

@@ -0,0 +1,23 @@
+{
+  "extends": "./node_modules/gts/",
+  "plugins": ["import"],
+  "rules": {
+    "@typescript-eslint/explicit-function-return-type": [
+      "error",
+      {"allowExpressions": true}
+    ],
+    "func-style": ["error", "declaration"],
+    "prefer-const": ["error", {"destructuring": "all"}],
+    // It would be nice to sort import declaration order as well, but that's not
+    // autofixable and it's not worth the effort of handling manually.
+    "sort-imports": ["error", {"ignoreDeclarationSort": true}],
+  },
+  "overrides": [
+    {
+      "files": ["**/*.ts"],
+      "rules": {
+        "import/no-commonjs": "error"
+      }
+    }
+  ]
+}

analysis/.prettierrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  ...require('gts/.prettierrc.json'),
+};

analysis/README.md

@@ -1,15 +1,65 @@
-This package provides a shared set of analysis options for use by Sass team
-packages. To use it, add it as a Git dependency to your `pubspec.yaml`:
+This package provides a shared static analysis configuration for use by Sass
+team Dart and TypeScript packages.
+
+## Use from Dart
+
+Add this as a Git dependency to your `pubspec.yaml`:
 
 ```yaml
 dev_dependencies:
   sass_analysis:
-    git: {url: 
-    https://github.com/sass/dart-sass.git, path: analysis}
+    git: {url: https://github.com/sass/dart-sass.git, path: analysis}
 ```
 
 and include it in your `analysis_options.yaml`:
 
 ```yaml
 include: package:sass_analysis/analysis_options.yaml
 ```
+
+## Use from TypeScript
+
+Add this and [gts] as Git dependencies to your `package.json`, then initialize
+gts:
+
+[gts]: https://github.com/google/gts
+
+```sh
+$ npm i --save-dev gts 'https://gitpkg.vercel.app/sass/dart-sass/analysis?main'
+$ npx gts init
+```
+
+Then edit the configuration files to use Sass-specific customizations instead of
+the gts defaults:
+
+* `eslintrc.json`:
+
+  ```json
+  {
+    "extends": "./node_modules/sass-analysis/"
+  }
+  ```
+
+* `.prettierrc.js`:
+
+  ```json
+  module.exports = {
+    ...require(sass-analysis/.prettierrc.js')
+  }
+  ```
+
+* `tsconfig.json`:
+
+  ```json
+  {
+    "extends": "./node_modules/sass-analysis/tsconfig.json",
+    "compilerOptions": {
+      "rootDir": ".",
+      "outDir": "build"
+    },
+    "include": [
+      "src/**/*.ts",
+      "test/**/*.ts"
+    ]
+  }
+  ```

analysis/index.js

@@ -0,0 +1,6 @@
+const fs = require('node:fs');
+const jsonc = require('jsonc-parser');
+
+module.exports = jsonc.parse(
+  fs.readFileSync(require.resolve('./.eslintrc'), 'utf8')
+);

analysis/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "sass-analysis",
+  "version": "0.0.0",
+  "description": "Shared static analysis options for Sass team packages.",
+  "dependencies": {
+    "eslint-plugin-import": "^2.30.0",
+    "gts": "^5.0.0",
+    "jsonc-parser": "^3.3.1"
+  }
+}

analysis/pubspec.yaml

@@ -1,7 +1,7 @@
 name: sass_analysis
 version: 0.0.0
 description: Shared analysis options for Sass team packages.
-homepage: https://github.com/sass/dart-sass/tree/master/analysis
+homepage: https://github.com/sass/dart-sass/tree/main/analysis
 
 publish_to: none
 

analysis/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "./node_modules/gts/tsconfig-google.json"
+}

pkg/sass-parser/.eslintrc

@@ -1,14 +1,3 @@
 {
-  "extends": "./node_modules/gts/",
-  "rules": {
-    "@typescript-eslint/explicit-function-return-type": [
-      "error",
-      {"allowExpressions": true}
-    ],
-    "func-style": ["error", "declaration"],
-    "prefer-const": ["error", {"destructuring": "all"}],
-    // It would be nice to sort import declaration order as well, but that's not
-    // autofixable and it's not worth the effort of handling manually.
-    "sort-imports": ["error", {"ignoreDeclarationSort": true}],
-  }
+  "extends": "./node_modules/sass-analysis/"
 }

pkg/sass-parser/.prettierrc.js

@@ -1,3 +1,3 @@
 module.exports = {
-  ...require('gts/.prettierrc.json'),
+  ...require('sass-analysis/.prettierrc.js'),
 };