Extract default sass plugin from heft to its own heft-sass-plugin

apps/heft/package.json

@@ -42,9 +42,6 @@
     "fast-glob": "~3.2.4",
     "glob": "~7.0.5",
     "glob-escape": "~0.0.2",
-    "node-sass": "5.0.0",
-    "postcss": "7.0.32",
-    "postcss-modules": "~1.5.0",
     "prettier": "~2.3.0",
     "semver": "~7.3.0",
     "tapable": "1.1.3",
@@ -60,7 +57,6 @@
     "@types/glob": "7.1.1",
     "@types/heft-jest": "1.0.1",
     "@types/node": "10.17.13",
-    "@types/node-sass": "4.11.1",
     "@types/semver": "7.3.5",
     "colors": "~1.2.1",
     "tslint": "~5.20.1",

apps/heft/src/pluginFramework/PluginManager.ts

@@ -20,7 +20,6 @@ import { DeleteGlobsPlugin } from '../plugins/DeleteGlobsPlugin';
 import { CopyStaticAssetsPlugin } from '../plugins/CopyStaticAssetsPlugin';
 import { RunScriptPlugin } from '../plugins/RunScriptPlugin';
 import { ApiExtractorPlugin } from '../plugins/ApiExtractorPlugin/ApiExtractorPlugin';
-import { SassTypingsPlugin } from '../plugins/SassTypingsPlugin/SassTypingsPlugin';
 import { ProjectValidatorPlugin } from '../plugins/ProjectValidatorPlugin';
 import { ToolPackageResolver } from '../utilities/ToolPackageResolver';
 import { NodeServicePlugin } from '../plugins/NodeServicePlugin';
@@ -53,7 +52,6 @@ export class PluginManager {
     this._applyPlugin(new DeleteGlobsPlugin());
     this._applyPlugin(new RunScriptPlugin());
     this._applyPlugin(new ApiExtractorPlugin(taskPackageResolver));
-    this._applyPlugin(new SassTypingsPlugin());
     this._applyPlugin(new ProjectValidatorPlugin());
     this._applyPlugin(new NodeServicePlugin());
   }

apps/heft/src/utilities/CoreConfigFiles.ts

@@ -13,7 +13,6 @@ import { IApiExtractorPluginConfiguration } from '../plugins/ApiExtractorPlugin/
 import { ITypeScriptConfigurationJson } from '../plugins/TypeScriptPlugin/TypeScriptPlugin';
 import { HeftConfiguration } from '../configuration/HeftConfiguration';
 import { Terminal } from '@rushstack/node-core-library';
-import { ISassConfigurationJson } from '../plugins/SassTypingsPlugin/SassTypingsPlugin';
 import { INodeServicePluginConfiguration } from '../plugins/NodeServicePlugin';
 
 export enum HeftEvent {
@@ -125,7 +124,6 @@ export class CoreConfigFiles {
   private static _nodeServiceConfigurationLoader:
     | ConfigurationFile<INodeServicePluginConfiguration>
     | undefined;
-  private static _sassConfigurationFileLoader: ConfigurationFile<ISassConfigurationJson> | undefined;
 
   /**
    * Returns the loader for the `config/heft.json` config file.
@@ -283,27 +281,6 @@ export class CoreConfigFiles {
     return CoreConfigFiles._nodeServiceConfigurationLoader;
   }
 
-  public static get sassConfigurationFileLoader(): ConfigurationFile<ISassConfigurationJson> {
-    const schemaPath: string = path.resolve(__dirname, '..', 'schemas', 'sass.schema.json');
-    CoreConfigFiles._sassConfigurationFileLoader = new ConfigurationFile<ISassConfigurationJson>({
-      projectRelativeFilePath: 'config/sass.json',
-      jsonSchemaPath: schemaPath,
-      jsonPathMetadata: {
-        '$.importIncludePaths.*': {
-          pathResolutionMethod: PathResolutionMethod.resolvePathRelativeToProjectRoot
-        },
-        '$.generatedTsFolder.*': {
-          pathResolutionMethod: PathResolutionMethod.resolvePathRelativeToProjectRoot
-        },
-        '$.srcFolder.*': {
-          pathResolutionMethod: PathResolutionMethod.resolvePathRelativeToProjectRoot
-        }
-      }
-    });
-
-    return CoreConfigFiles._sassConfigurationFileLoader;
-  }
-
   private static _addEventActionToMap<TEventAction extends IHeftConfigurationJsonEventActionBase>(
     eventAction: TEventAction,
     map: Map<HeftEvent, TEventAction[]>

apps/heft/tsconfig.json

@@ -5,5 +5,5 @@
     "typeRoots": ["./custom-typings", "./node_modules/@types/"],
     "types": ["heft-jest", "node"]
   },
-  "include": ["src/**/*.ts", "src/**/*.tsx", "./custom-typings/**/*.ts"]
+  "include": ["src/**/*.ts", "src/**/*.tsx"]
 }

build-tests/heft-sass-test/config/heft.json

@@ -52,6 +52,12 @@
        * The path to the plugin package.
        */
       "plugin": "@rushstack/heft-jest-plugin"
+    },
+    {
+      /**
+       * The path to the plugin package.
+       */
+      "plugin": "@rushstack/heft-sass-plugin"
     }
   ]
 }

build-tests/heft-sass-test/package.json

@@ -11,6 +11,7 @@
     "@rushstack/eslint-config": "workspace:*",
     "@rushstack/heft": "workspace:*",
     "@rushstack/heft-jest-plugin": "workspace:*",
+    "@rushstack/heft-sass-plugin": "workspace:*",
     "@rushstack/heft-webpack4-plugin": "workspace:*",
     "@types/heft-jest": "1.0.1",
     "@types/react-dom": "16.9.8",

common/config/rush/browser-approved-packages.json

@@ -2,6 +2,10 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/rush/v5/approved-packages.schema.json",
   "packages": [
+    {
+      "name": "@rushstack/heft-sass-plugin",
+      "allowedCategories": [ "tests" ]
+    },
     {
       "name": "react",
       "allowedCategories": [ "tests" ]

common/config/rush/repo-state.json

@@ -1,5 +1,5 @@
 // DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush.
 {
-  "pnpmShrinkwrapHash": "f45464cdd2ef1f79ab3446b3edd2384175b1e967",
+  "pnpmShrinkwrapHash": "90d9a6f48b14750485b141fc7547965bcb69bb9f",
   "preferredVersionsHash": "1fbc26d2c5b3248616b9edccd6bef064075243bc"
 }

common/reviews/api/heft-sass-plugin.api.md

@@ -0,0 +1,13 @@
+## API Report File for "@rushstack/heft-sass-plugin"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { IHeftPlugin } from '@rushstack/heft';
+
+// @public (undocumented)
+const _default: IHeftPlugin<void>;
+export default _default;
+
+```

heft-plugins/heft-sass-plugin/.eslintrc.js

@@ -0,0 +1,10 @@
+// This is a workaround for https://github.com/eslint/eslint/issues/3458
+require('@rushstack/eslint-config/patch/modern-module-resolution');
+
+module.exports = {
+  extends: [
+    '@rushstack/eslint-config/profile/node-trusted-tool',
+    '@rushstack/eslint-config/mixins/friendly-locals'
+  ],
+  parserOptions: { tsconfigRootDir: __dirname }
+};

heft-plugins/heft-sass-plugin/.npmignore

@@ -0,0 +1,30 @@
+# THIS IS A STANDARD TEMPLATE FOR .npmignore FILES IN THIS REPO.
+
+# Ignore all files by default, to avoid accidentally publishing unintended files.
+*
+
+# Use negative patterns to bring back the specific things we want to publish.
+!/bin/**
+!/lib/**
+!/lib-*/**
+!/dist/**
+!ThirdPartyNotice.txt
+
+# Ignore certain patterns that should not get published.
+/dist/*.stats.*
+/lib/**/test/
+/lib-*/**/test/
+*.test.js
+
+# NOTE: These don't need to be specified, because NPM includes them automatically.
+#
+# package.json
+# README (and its variants)
+# CHANGELOG (and its variants)
+# LICENSE / LICENCE
+
+#--------------------------------------------
+# DO NOT MODIFY THE TEMPLATE ABOVE THIS LINE
+#--------------------------------------------
+
+# (Add your project-specific overrides here)

heft-plugins/heft-sass-plugin/LICENSE

@@ -0,0 +1,24 @@
+@rushstack/heft-sass-plugin
+
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

heft-plugins/heft-sass-plugin/README.md

@@ -0,0 +1,11 @@
+# @rushstack/heft-sass-plugin
+
+This is a Heft plugin for using node-sass during the "build" stage.
+
+## Links
+
+- [CHANGELOG.md](
+  https://github.com/microsoft/rushstack/blob/master/heft-plugins/heft-sass-plugin/CHANGELOG.md) - Find
+  out what's new in the latest version
+
+Heft is part of the [Rush Stack](https://rushstack.io/) family of projects.

heft-plugins/heft-sass-plugin/config/api-extractor.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+
+  "mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts",
+  "apiReport": {
+    "enabled": true,
+    "reportFolder": "../../../common/reviews/api"
+  },
+  "docModel": {
+    "enabled": false
+  },
+  "dtsRollup": {
+    "enabled": true,
+    "betaTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts"
+  }
+}

heft-plugins/heft-sass-plugin/config/rig.json

@@ -0,0 +1,7 @@
+{
+  // The "rig.json" file directs tools to look for their config files in an external package.
+  // Documentation for this system: https://www.npmjs.com/package/@rushstack/rig-package
+  "$schema": "https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json",
+
+  "rigPackageName": "@rushstack/heft-node-rig"
+}