Update extends documentation

dmichon-msft · dmichon-msft · commit 0ae37339d0c4 · 2025-04-16T01:21:27.000Z
diff --git a/apps/api-extractor/config/heft.json b/apps/api-extractor/config/heft.json
@@ -7,6 +7,8 @@
   /**
    * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
    * settings to be shared across multiple projects.
+   *
+   * To delete an inherited setting, set it to `null` in this file.
    */
   "extends": "decoupled-local-node-rig/profiles/default/config/heft.json",
 
diff --git a/apps/heft/src/schemas/heft-legacy.schema.json b/apps/heft/src/schemas/heft-legacy.schema.json
@@ -20,7 +20,7 @@
     },
 
     "extends": {
-      "description": "Optionally specifies another JSON config file that this file extends from.  This provides a way for standard settings to be shared across multiple projects.",
+      "description": "Optionally specifies another JSON config file that this file extends from.  This provides a way for standard settings to be shared across multiple projects. To delete an inherited setting, set it to `null` in this file.",
       "type": "string"
     },
 
diff --git a/apps/heft/src/schemas/heft.schema.json b/apps/heft/src/schemas/heft.schema.json
@@ -104,7 +104,7 @@
     },
 
     "extends": {
-      "description": "Optionally specifies another JSON config file that this file extends from.  This provides a way for standard settings to be shared across multiple projects.",
+      "description": "Optionally specifies another JSON config file that this file extends from.  This provides a way for standard settings to be shared across multiple projects. To delete an inherited setting, set it to `null` in this file.",
       "type": "string"
     },
 
diff --git a/apps/heft/src/schemas/node-service.schema.json b/apps/heft/src/schemas/node-service.schema.json
@@ -13,7 +13,7 @@
     },
 
     "extends": {
-      "description": "Optionally specifies another JSON config file that this file extends from.  This provides a way for standard settings to be shared across multiple projects.",
+      "description": "Optionally specifies another JSON config file that this file extends from.  This provides a way for standard settings to be shared across multiple projects. To delete an inherited setting, set it to `null` in this file.",
       "type": "string"
     },
 
diff --git a/apps/heft/src/schemas/templates/heft.json b/apps/heft/src/schemas/templates/heft.json
@@ -7,6 +7,8 @@
   /**
    * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
    * settings to be shared across multiple projects.
+   *
+   * To delete an inherited setting, set it to `null` in this file.
    */
   // "extends": "base-project/config/heft.json",
 
diff --git a/apps/lockfile-explorer-web/config/heft.json b/apps/lockfile-explorer-web/config/heft.json
@@ -7,6 +7,8 @@
   /**
    * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
    * settings to be shared across multiple projects.
+   *
+   * To delete an inherited setting, set it to `null` in this file.
    */
   "extends": "local-web-rig/profiles/app/config/heft.json",
 
diff --git a/apps/lockfile-explorer/config/heft.json b/apps/lockfile-explorer/config/heft.json
@@ -7,6 +7,8 @@
   /**
    * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
    * settings to be shared across multiple projects.
+   *
+   * To delete an inherited setting, set it to `null` in this file.
    */
   "extends": "local-node-rig/profiles/default/config/heft.json",
 
diff --git a/apps/lockfile-explorer/config/node-service.json b/apps/lockfile-explorer/config/node-service.json
@@ -8,6 +8,8 @@
   /**
    * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
    * settings to be shared across multiple projects.
+   *
+   * To delete an inherited setting, set it to `null` in this file.
    */
   // "extends": "base-project/config/serve-command.json",
 
diff --git a/build-tests-samples/heft-web-rig-library-tutorial/config/api-extractor.json b/build-tests-samples/heft-web-rig-library-tutorial/config/api-extractor.json
@@ -8,6 +8,8 @@
    * Optionally specifies another JSON config file that this file extends from.  This provides a way for
    * standard settings to be shared across multiple projects.
    *
+   * To delete an inherited setting, set it to `null` in this file.
+   *
    * If the path starts with "./" or "../", the path is resolved relative to the folder of the file that contains
    * the "extends" field.  Otherwise, the first path segment is interpreted as an NPM package name, and will be
    * resolved using NodeJS require().
diff --git a/build-tests/heft-fastify-test/config/node-service.json b/build-tests/heft-fastify-test/config/node-service.json
@@ -8,6 +8,8 @@
   /**
    * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
    * settings to be shared across multiple projects.
+   *
+   * To delete an inherited setting, set it to `null` in this file.
    */
   // "extends": "base-project/config/serve-command.json",
 
diff --git a/build-tests/localization-plugin-test-01/config/heft.json b/build-tests/localization-plugin-test-01/config/heft.json
@@ -7,6 +7,8 @@
   /**
    * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
    * settings to be shared across multiple projects.
+   *
+   * To delete an inherited setting, set it to `null` in this file.
    */
   "extends": "local-node-rig/profiles/default/config/heft.json",
 
diff --git a/build-tests/localization-plugin-test-02/config/heft.json b/build-tests/localization-plugin-test-02/config/heft.json
@@ -7,6 +7,8 @@
   /**
    * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
    * settings to be shared across multiple projects.
+   *
+   * To delete an inherited setting, set it to `null` in this file.
    */
   "extends": "local-node-rig/profiles/default/config/heft.json",
 
diff --git a/common/changes/@microsoft/api-extractor/config-file-null_2025-04-16-01-15.json b/common/changes/@microsoft/api-extractor/config-file-null_2025-04-16-01-15.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Update documentation for ",
+      "type": "patch",
+      "packageName": "@microsoft/api-extractor"
+    }
+  ],
+  "packageName": "@microsoft/api-extractor",
+  "email": "dmichon-msft@users.noreply.github.com"
+}
diff --git a/common/changes/@microsoft/rush/config-file-null_2025-04-16-01-15.json b/common/changes/@microsoft/rush/config-file-null_2025-04-16-01-15.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Update documentation for ",
+      "type": "none",
+      "packageName": "@microsoft/rush"
+    }
+  ],
+  "packageName": "@microsoft/rush",
+  "email": "dmichon-msft@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/heft-api-extractor-plugin/config-file-null_2025-04-16-01-15.json b/common/changes/@rushstack/heft-api-extractor-plugin/config-file-null_2025-04-16-01-15.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Update documentation for ",
+      "type": "patch",
+      "packageName": "@rushstack/heft-api-extractor-plugin"
+    }
+  ],
+  "packageName": "@rushstack/heft-api-extractor-plugin",
+  "email": "dmichon-msft@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/heft-node-rig/config-file-null_2025-04-16-01-15.json b/common/changes/@rushstack/heft-node-rig/config-file-null_2025-04-16-01-15.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Update documentation for ",
+      "type": "patch",
+      "packageName": "@rushstack/heft-node-rig"
+    }
+  ],
+  "packageName": "@rushstack/heft-node-rig",
+  "email": "dmichon-msft@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/heft-sass-plugin/config-file-null_2025-04-16-01-15.json b/common/changes/@rushstack/heft-sass-plugin/config-file-null_2025-04-16-01-15.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Update documentation for ",
+      "type": "patch",
+      "packageName": "@rushstack/heft-sass-plugin"
+    }
+  ],
+  "packageName": "@rushstack/heft-sass-plugin",
+  "email": "dmichon-msft@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/heft-typescript-plugin/config-file-null_2025-04-16-01-15.json b/common/changes/@rushstack/heft-typescript-plugin/config-file-null_2025-04-16-01-15.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Update documentation for ",
+      "type": "patch",
+      "packageName": "@rushstack/heft-typescript-plugin"
+    }
+  ],
+  "packageName": "@rushstack/heft-typescript-plugin",
+  "email": "dmichon-msft@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/heft-web-rig/config-file-null_2025-04-16-01-15.json b/common/changes/@rushstack/heft-web-rig/config-file-null_2025-04-16-01-15.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Update documentation for ",
+      "type": "patch",
+      "packageName": "@rushstack/heft-web-rig"
+    }
+  ],
+  "packageName": "@rushstack/heft-web-rig",
+  "email": "dmichon-msft@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/heft/config-file-null_2025-04-16-01-15.json b/common/changes/@rushstack/heft/config-file-null_2025-04-16-01-15.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Update documentation for ",
+      "type": "patch",
+      "packageName": "@rushstack/heft"
+    }
+  ],
+  "packageName": "@rushstack/heft",
+  "email": "dmichon-msft@users.noreply.github.com"
+}
diff --git a/common/changes/@rushstack/lockfile-explorer/config-file-null_2025-04-16-01-15.json b/common/changes/@rushstack/lockfile-explorer/config-file-null_2025-04-16-01-15.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Update documentation for ",
+      "type": "patch",
+      "packageName": "@rushstack/lockfile-explorer"
+    }
+  ],
+  "packageName": "@rushstack/lockfile-explorer",
+  "email": "dmichon-msft@users.noreply.github.com"
+}
diff --git a/heft-plugins/heft-api-extractor-plugin/src/schemas/api-extractor-task.schema.json b/heft-plugins/heft-api-extractor-plugin/src/schemas/api-extractor-task.schema.json
@@ -13,7 +13,7 @@
     },
 
     "extends": {
-      "description": "Optionally specifies another JSON config file that this file extends from.  This provides a way for standard settings to be shared across multiple projects.",
+      "description": "Optionally specifies another JSON config file that this file extends from.  This provides a way for standard settings to be shared across multiple projects. To delete an inherited setting, set it to `null` in this file.",
       "type": "string"
     },
 
diff --git a/heft-plugins/heft-sass-plugin/src/schemas/heft-sass-plugin.schema.json b/heft-plugins/heft-sass-plugin/src/schemas/heft-sass-plugin.schema.json
@@ -13,7 +13,7 @@
     },
 
     "extends": {
-      "description": "Optionally specifies another JSON config file that this file extends from.  This provides a way for standard settings to be shared across multiple projects.",
+      "description": "Optionally specifies another JSON config file that this file extends from.  This provides a way for standard settings to be shared across multiple projects. To delete an inherited setting, set it to `null` in this file.",
       "type": "string"
     },
 
diff --git a/heft-plugins/heft-sass-plugin/src/templates/sass.json b/heft-plugins/heft-sass-plugin/src/templates/sass.json
@@ -7,6 +7,8 @@
   /**
    * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
    * settings to be shared across multiple projects.
+   *
+   * To delete an inherited setting, set it to `null` in this file.
    */
   // "extends": "base-project/config/serve-command.json",
 
diff --git a/heft-plugins/heft-typescript-plugin/src/schemas/typescript.schema.json b/heft-plugins/heft-typescript-plugin/src/schemas/typescript.schema.json
@@ -13,7 +13,7 @@
     },
 
     "extends": {
-      "description": "Optionally specifies another JSON config file that this file extends from.  This provides a way for standard settings to be shared across multiple projects.",
+      "description": "Optionally specifies another JSON config file that this file extends from.  This provides a way for standard settings to be shared across multiple projects. To delete an inherited setting, set it to `null` in this file.",
       "type": "string"
     },
 
diff --git a/libraries/rush-lib/assets/website-only/rush-project.json b/libraries/rush-lib/assets/website-only/rush-project.json
@@ -8,6 +8,8 @@
   /**
    * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
    * settings to be shared across multiple projects.
+   *
+   * To delete an inherited setting, set it to `null` in this file.
    */
   // "extends": "my-rig/profiles/default/config/rush-project.json",
 
diff --git a/libraries/rush-lib/src/schemas/pnpm-config.schema.json b/libraries/rush-lib/src/schemas/pnpm-config.schema.json
@@ -11,7 +11,7 @@
     },
 
     "extends": {
-      "description": "Optionally specifies another JSON config file that this file extends from. This provides a way for standard settings to be shared across multiple projects.",
+      "description": "Optionally specifies another JSON config file that this file extends from. This provides a way for standard settings to be shared across multiple projects. To delete an inherited setting, set it to `null` in this file.",
       "type": "string"
     },
 
diff --git a/libraries/rush-lib/src/schemas/rush-project.schema.json b/libraries/rush-lib/src/schemas/rush-project.schema.json
@@ -12,7 +12,7 @@
     },
 
     "extends": {
-      "description": "Optionally specifies another JSON config file that this file extends from. This provides a way for standard settings to be shared across multiple projects.",
+      "description": "Optionally specifies another JSON config file that this file extends from. This provides a way for standard settings to be shared across multiple projects. To delete an inherited setting, set it to `null` in this file.",
       "type": "string"
     },
 
diff --git a/rigs/heft-node-rig/profiles/default/config/heft.json b/rigs/heft-node-rig/profiles/default/config/heft.json
@@ -7,6 +7,8 @@
   /**
    * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
    * settings to be shared across multiple projects.
+   *
+   * To delete an inherited setting, set it to `null` in this file.
    */
   // "extends": "base-project/config/heft.json",
 
diff --git a/rigs/heft-node-rig/profiles/default/config/typescript.json b/rigs/heft-node-rig/profiles/default/config/typescript.json
@@ -7,6 +7,8 @@
   /**
    * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
    * settings to be shared across multiple projects.
+   *
+   * To delete an inherited setting, set it to `null` in this file.
    */
   // "extends": "base-project/config/typescript.json",
 
diff --git a/rigs/heft-web-rig/profiles/app/config/heft.json b/rigs/heft-web-rig/profiles/app/config/heft.json
@@ -7,6 +7,8 @@
   /**
    * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
    * settings to be shared across multiple projects.
+   *
+   * To delete an inherited setting, set it to `null` in this file.
    */
   // "extends": "base-project/config/heft.json",
 
diff --git a/rigs/heft-web-rig/profiles/app/config/sass.json b/rigs/heft-web-rig/profiles/app/config/sass.json
@@ -10,6 +10,8 @@
   /**
    * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
    * settings to be shared across multiple projects.
+   *
+   * To delete an inherited setting, set it to `null` in this file.
    */
   // "extends": "base-project/config/serve-command.json",
 
diff --git a/rigs/heft-web-rig/profiles/app/config/typescript.json b/rigs/heft-web-rig/profiles/app/config/typescript.json
@@ -7,6 +7,8 @@
   /**
    * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
    * settings to be shared across multiple projects.
+   *
+   * To delete an inherited setting, set it to `null` in this file.
    */
   // "extends": "base-project/config/typescript.json",
 
diff --git a/rigs/heft-web-rig/profiles/library/config/api-extractor-task.json b/rigs/heft-web-rig/profiles/library/config/api-extractor-task.json
@@ -10,6 +10,8 @@
   /**
    * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
    * settings to be shared across multiple projects.
+   *
+   * To delete an inherited setting, set it to `null` in this file.
    */
   // "extends": "base-project/config/api-extractor-task.json",
 
diff --git a/rigs/heft-web-rig/profiles/library/config/heft.json b/rigs/heft-web-rig/profiles/library/config/heft.json
@@ -7,6 +7,8 @@
   /**
    * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
    * settings to be shared across multiple projects.
+   *
+   * To delete an inherited setting, set it to `null` in this file.
    */
   // "extends": "base-project/config/heft.json",
 
diff --git a/rigs/heft-web-rig/profiles/library/config/sass.json b/rigs/heft-web-rig/profiles/library/config/sass.json
@@ -10,6 +10,8 @@
   /**
    * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
    * settings to be shared across multiple projects.
+   *
+   * To delete an inherited setting, set it to `null` in this file.
    */
   // "extends": "base-project/config/serve-command.json",
 
diff --git a/rigs/heft-web-rig/profiles/library/config/typescript.json b/rigs/heft-web-rig/profiles/library/config/typescript.json
@@ -7,6 +7,8 @@
   /**
    * Optionally specifies another JSON config file that this file extends from. This provides a way for standard
    * settings to be shared across multiple projects.
+   *
+   * To delete an inherited setting, set it to `null` in this file.
    */
   // "extends": "base-project/config/typescript.json",
 
diff --git a/rush-plugins/rush-serve-plugin/src/schemas/rush-project-serve.schema.json b/rush-plugins/rush-serve-plugin/src/schemas/rush-project-serve.schema.json
@@ -12,7 +12,7 @@
     },
 
     "extends": {
-      "description": "Optionally specifies another JSON config file that this file extends from. This provides a way for standard settings to be shared across multiple projects.",
+      "description": "Optionally specifies another JSON config file that this file extends from. This provides a way for standard settings to be shared across multiple projects. To delete an inherited setting, set it to `null` in this file.",
       "type": "string"
     },
 

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,8 @@`
`8`	`8`	`* Optionally specifies another JSON config file that this file extends from. This provides a way for`
`9`	`9`	`* standard settings to be shared across multiple projects.`
`10`	`10`	`*`
	`11`	+ * To delete an inherited setting, set it to `null` in this file.
	`12`	`+ *`
`11`	`13`	`* If the path starts with "./" or "../", the path is resolved relative to the folder of the file that contains`
`12`	`14`	`* the "extends" field. Otherwise, the first path segment is interpreted as an NPM package name, and will be`
`13`	`15`	`* resolved using NodeJS require().`