@aws/nx-plugin 0.2.1 → 0.3.0

package/LICENSE-THIRD-PARTY

@@ -10801,7 +10801,7 @@ THE SOFTWARE.
 
 ---
 
-The following software may be included in this product: fast-glob (3.3.2)
+The following software may be included in this product: fast-glob (3.3.3)
 This software contains the following license and notice below:
 
 The MIT License (MIT)
@@ -38984,6 +38984,27 @@ IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 ---
 
+The following software may be included in this product: minimatch (10.0.1)
+This software contains the following license and notice below:
+
+The ISC License
+
+Copyright (c) 2011-2023 Isaac Z. Schlueter and Contributors
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
+IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+---
+
 The following software may be included in this product: minipass (7.1.2)
 This software contains the following license and notice below:
 

package/generators.json

@@ -38,6 +38,17 @@
       "factory": "./src/trpc/react/generator",
       "schema": "./src/trpc/react/schema.json",
       "description": "provides React integration to a React website"
+    },
+    "license": {
+      "factory": "./src/license/generator",
+      "schema": "./src/license/schema.json",
+      "description": "Add LICENSE files and configure source code licence headers"
+    },
+    "license#sync": {
+      "factory": "./src/license/sync/generator",
+      "schema": "./src/license/sync/schema.json",
+      "description": "Sync generator for writing licence headers and subproject LICENSE files",
+      "hidden": true
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws/nx-plugin",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "private": false,
   "type": "commonjs",
   "license": "Apache-2.0",
@@ -11,7 +11,8 @@
   },
   "generators": "./generators.json",
   "peerDependencies": {
-    "prettier": "^3.4.2"
+    "prettier": "^3.4.2",
+    "nx": "20.4.0"
   },
   "dependencies": {
     "@nx/devkit": "^20.4.0",
@@ -20,7 +21,9 @@
     "@nx/react": "^20.4.0",
     "@nx/vite": "^20.4.0",
     "@phenomnomnominal/tsquery": "6.1.3",
+    "fast-glob": "^3.3.3",
     "lodash.kebabcase": "4.1.1",
+    "minimatch": "^10.0.1",
     "typescript": "~5.5.4",
     "vite": "^5.4.0",
     "vitest": "^1.6.0"

package/src/index.d.ts

@@ -2,3 +2,4 @@
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
+export * from './utils/config';

package/src/index.js

@@ -1,5 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
 /**
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
+tslib_1.__exportStar(require("./utils/config"), exports);
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/nx-plugin/src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/nx-plugin/src/index.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,yDAA+B"}

package/src/license/README.md

@@ -0,0 +1,255 @@
+# License Generator
+
+## Overview
+
+This generator configures `LICENSE` files and source file headers for your project. After you run this generator, a [sync generator](https://nx.dev/concepts/sync-generators) is registered to execute as part of your `lint` targets which will ensure that your source files conform to the desired license content and format, as well as ensuring that all projects in your workspace contain a copy of the root `LICENSE` file.
+
+## Usage
+
+You can run the generator in two ways:
+
+### 1. Using VSCode IDE
+
+First, install the NX Console extension for VSCode:
+
+1. Open VSCode
+2. Go to Extensions (Ctrl+Shift+X / Cmd+Shift+X)
+3. Search for "Nx Console"
+4. Install [Nx Console](https://marketplace.visualstudio.com/items?itemName=nrwl.angular-console)
+
+Then generate your API:
+
+1. Open the NX Console in VSCode
+2. Click on "Generate"
+3. Search for "license"
+4. Fill in the required parameters in the form
+5. Click "Run"
+
+### 2. Using CLI
+
+Generate the API:
+
+```bash
+nx g @aws/nx-plugin:license my-api --copyrightHolder="My Company, Inc." --license=MIT
+```
+
+You can also perform a dry-run to see what files would be generated or updated without actually creating them:
+
+```bash
+nx g @aws/nx-plugin:license my-api --copyrightHolder="My Company, Inc." --license=MIT --dry-run
+```
+
+Both methods will create a root `LICENSE` file based on your selected license and copyright holder, as well as configuring the sync generator to ensure that source files specify the correct license header.
+
+## Input Parameters
+
+| Parameter       | Type   | Default                              | Description                                                                            |
+| --------------- | ------ | ------------------------------------ | -------------------------------------------------------------------------------------- |
+| license         | string | "Apache-2.0"                         | The SPDX license identifier for your chosen license.                                   |
+| copyrightHolder | string | "Amazon.com, Inc. or its affiliates" | The copyright holder, included in the LICENSE file and source file headers by default. |
+
+## Expected Output
+
+The generator will create or update the following files:
+
+```
+└── LICENSE                    # The content is written based on the selected license
+└── package.json               # The "license" field is updated with the selected license
+└── nx.json                    # The "lint" target is configured to sync LICENSE files and source file headers
+└── aws-nx-plugin.config.mts   # Configuration for the license sync, such as customising the license header content and format for different languages
+```
+
+Some default configuration for license header content and format is added to `aws-nx-plugin.config.mts` to write appropriate headers for a handful of file types. You may wish to customise this further; please see the [configuration section](#configuration) below.
+
+## License Sync Behaviour
+
+The license sync generator performs two main tasks:
+
+### 1. Synchronise Source File License Headers
+
+When the sync generator is run, it will ensure that all source code files in your workspace (based on your configuration) contain the appropriate license header. The header is written as the first block comment or consecutive series of line comments in the file (besides the shebang/hashbang if present in a file).
+
+You can update the configuration at any time to change which files should be included or excluded, as well as the content or format of license headers for different file types. For more details, please see the [configuration section](#configuration) below.
+
+### 2. Synchronise LICENSE Files
+
+When the sync generator is run, it will ensure that all projects in your workspace contain the same `LICENSE` file as the `LICENSE` file in the root of your workspace. If your workspace does not have a root LICENSE file, this is skipped.
+
+You can exclude projects in the configuration if required. For more details, please see the [configuration section](#configuration) below.
+
+## Configuration
+
+Configuration is defined in the `aws-nx-plugin.config.mts` file in the root of your workspace.
+
+### License header content
+
+The license header content can be configured in two ways:
+
+1. Using inline content:
+
+```typescript
+{
+  license: {
+    header: {
+      content: {
+        lines: ['Copyright My Company, Inc.', 'Licensed under MIT License', 'All rights reserved'];
+      }
+      // ... format configuration
+    }
+  }
+}
+```
+
+2. Loading from a file:
+
+```typescript
+{
+  license: {
+    header: {
+      content: {
+        filePath: 'license-header.txt'; // relative to workspace root
+      }
+      // ... format configuration
+    }
+  }
+}
+```
+
+### Including files and specifying a format
+
+You can specify how license headers should be formatted for different file types using glob patterns. The format configuration supports line comments, block comments, or a combination of both:
+
+```typescript
+{
+  license: {
+    header: {
+      content: {
+        lines: ['Copyright notice here']
+      },
+      format: {
+        // Line comments
+        '**/*.ts': {
+          lineStart: '// '
+        },
+
+        // Block comments
+        '**/*.css': {
+          blockStart: '/*',
+          blockEnd: '*/'
+        },
+
+        // Block comments with line prefixes
+        '**/*.java': {
+          blockStart: '/*',
+          lineStart: ' * ',
+          blockEnd: ' */'
+        },
+
+        // Line comments with header/footer
+        '**/*.py': {
+          blockStart: '# ------------',
+          lineStart: '# ',
+          blockEnd: '# ------------'
+        }
+      }
+    }
+  }
+}
+```
+
+The format configuration supports:
+
+- `blockStart`: Text written before the license content (e.g., to start a block comment)
+- `lineStart`: Text prepended to each line of the license content
+- `lineEnd`: Text appended to each line of the license content
+- `blockEnd`: Text written after the license content (e.g., to end a block comment)
+
+### Custom comment syntax
+
+For file types that aren't natively supported, you can specify custom comment syntax:
+
+```typescript
+{
+  license: {
+    header: {
+      content: {
+        lines: ['My license header']
+      },
+      format: {
+        '**/*.xyz': {
+          lineStart: '## '
+        }
+      },
+      commentSyntax: {
+        xyz: {
+          line: '##'  // Define line comment syntax
+        },
+        abc: {
+          block: {    // Define block comment syntax
+            start: '<!--',
+            end: '-->'
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+This tells the sync generator how to identify existing license headers in these file types. The `commentSyntax` configuration supports:
+
+- `line`: Characters that start a line comment
+- `block`: Characters that start and end a block comment
+
+### Excluding files
+
+By default, in a git repository, all `.gitignore` files are honored to ensure that only files managed by version control are synchronized. In non-git repositories, all files are considered unless explicitly excluded in configuration.
+
+You can exclude additional files from license header synchronization using glob patterns:
+
+```typescript
+{
+  license: {
+    header: {
+      content: {
+        lines: ['My license header']
+      },
+      format: {
+        '**/*.ts': {
+          lineStart: '// '
+        }
+      },
+      exclude: [
+        '**/generated/**',
+        '**/dist/**',
+        'some-specific-file.ts'
+      ]
+    }
+  }
+}
+```
+
+### Excluding projects from LICENSE file sync
+
+You can exclude specific projects from LICENSE file synchronization using glob patterns:
+
+```typescript
+{
+  license: {
+    files: {
+      exclude: ['packages/excluded-project', 'apps/internal-*'];
+    }
+  }
+}
+```
+
+When excluded, these projects will not receive a copy of the root LICENSE file during synchronization.
+
+## Disabling license sync
+
+To disable the license sync generator:
+
+1. Remove the `license` section from your configuration in `aws-nx-plugin.config.mts` (or remove the `aws-nx-plugin.config.mts` file)
+2. Remove the `@aws/nx-plugin:license#sync` generator from `targetDefaults.lint.syncGenerators`
+
+To re-enable license sync, simply run the `license` generator again.

package/src/license/__snapshots__/config.spec.ts.snap

@@ -0,0 +1,89 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`license config > defaultLicenseConfig > should generate default license config for ASL 1`] = `
+{
+  "header": {
+    "content": {
+      "lines": [
+        "Copyright Test Inc. or its affiliates. All Rights Reserved.                                                      ",
+        "                                                                                                                 ",
+        "Licensed under the Amazon Software License (the "License"). You may not use this file except in compliance       ",
+        "with the License. A copy of the License is located at                                                            ",
+        "                                                                                                                 ",
+        "   https://aws.amazon.com/asl/                                                                                   ",
+        "                                                                                                                 ",
+        "or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES",
+        "OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions   ",
+        "and limitations under the License.                                                                               ",
+      ],
+    },
+    "exclude": [],
+    "format": {
+      "**/*.{js,ts}": {
+        "blockEnd": " **********************************************************************************************************************/",
+        "blockStart": "/**********************************************************************************************************************",
+        "lineEnd": " *",
+        "lineStart": " *  ",
+      },
+      "**/*.{py,sh}": {
+        "blockEnd": "######################################################################################################################",
+        "blockStart": "######################################################################################################################",
+        "lineEnd": " #",
+        "lineStart": "#  ",
+      },
+    },
+  },
+}
+`;
+
+exports[`license config > defaultLicenseConfig > should generate default license config for Apache-2.0 1`] = `
+{
+  "header": {
+    "content": {
+      "lines": [
+        "Copyright Test Inc. or its affiliates. All Rights Reserved.",
+        "SPDX-License-Identifier: Apache-2.0",
+      ],
+    },
+    "exclude": [],
+    "format": {
+      "**/*.{js,ts}": {
+        "blockEnd": " */",
+        "blockStart": "/**",
+        "lineStart": " * ",
+      },
+      "**/*.{py,sh}": {
+        "blockEnd": "# ",
+        "blockStart": "# ",
+        "lineStart": "# ",
+      },
+    },
+  },
+}
+`;
+
+exports[`license config > defaultLicenseConfig > should generate default license config for MIT 1`] = `
+{
+  "header": {
+    "content": {
+      "lines": [
+        "Copyright Test Inc. or its affiliates. All Rights Reserved.",
+        "SPDX-License-Identifier: MIT",
+      ],
+    },
+    "exclude": [],
+    "format": {
+      "**/*.{js,ts}": {
+        "blockEnd": " */",
+        "blockStart": "/**",
+        "lineStart": " * ",
+      },
+      "**/*.{py,sh}": {
+        "blockEnd": "# ",
+        "blockStart": "# ",
+        "lineStart": "# ",
+      },
+    },
+  },
+}
+`;

package/src/license/config-types.d.ts

@@ -0,0 +1,107 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export interface LicenseConfig {
+    /**
+     * Configuration for source code license headers
+     * Omit if you do not want any source code license headers to be synced
+     */
+    header?: LicenseHeaderConfig;
+    /**
+     * Configuration for LICENSE files
+     */
+    files?: LicenseFileConfig;
+}
+/**
+ * Configuration for the LICENSE file sync
+ */
+export interface LicenseFileConfig {
+    /**
+     * Exclude LICENSE file sync checks for the given glob patterns
+     */
+    exclude?: string[];
+}
+/**
+ * Specifies license content as a path to a file
+ */
+export interface LicenseFilePathContent {
+    /**
+     * Load the license text from the specified file (relative to the workspace root)
+     */
+    filePath: string;
+}
+/**
+ * Specifies license content inline
+ */
+export interface LicenseLinesContent {
+    /**
+     * Inline license text
+     */
+    lines: string[];
+}
+/**
+ * Configuration for source code license header sync
+ */
+export interface LicenseHeaderConfig {
+    /**
+     * Content of the license header
+     */
+    content: LicenseFilePathContent | LicenseLinesContent;
+    /**
+     * Specifies the license header format for given glob patterns
+     */
+    format: {
+        [filePattern: string]: LicenseHeaderFormat;
+    };
+    /**
+     * Exclude out of sync source code license header checks for the given glob patterns
+     */
+    exclude?: string[];
+    /**
+     * User-specified comment syntax for file types we don't have config for
+     */
+    commentSyntax?: {
+        [ext: string]: CommentSyntax;
+    };
+}
+/**
+ * Format settings for source code license headers
+ */
+export interface LicenseHeaderFormat {
+    /**
+     * Text written to the line prior to the license lines
+     * Use this to start a block comment if desired
+     */
+    blockStart?: string;
+    /**
+     * Text written to the start of each line of the license
+     */
+    lineStart?: string;
+    /**
+     * Text written to the end of each line of the license
+     */
+    lineEnd?: string;
+    /**
+     * Text written to the line after the license lines
+     * Use this to end a block comment if desired
+     */
+    blockEnd?: string;
+}
+/**
+ * Defines comment syntax for a particular language
+ * Used to instruct the license sync generator to find the first comment in a file
+ */
+export interface CommentSyntax {
+    /**
+     * If the language supports line comments, specify the character(s) used to start a line comment
+     */
+    line?: string;
+    /**
+     * If the language supports block comments, specify the character(s) used to start and end the block comment
+     */
+    block?: {
+        start: string;
+        end: string;
+    };
+}

package/src/license/config-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=config-types.js.map

package/src/license/config-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-types.js","sourceRoot":"","sources":["../../../../../packages/nx-plugin/src/license/config-types.ts"],"names":[],"mappings":""}

package/src/license/config.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Tree } from '@nx/devkit';
+import { SPDXLicenseIdentifier } from './schema';
+import { CommentSyntax, LicenseConfig } from './config-types';
+/**
+ * Defines the comment syntax for popular programming languages
+ */
+export declare const LANGUAGE_COMMENT_SYNTAX: {
+    [ext: string]: CommentSyntax;
+};
+/**
+ * Build the default license config for a given license
+ */
+export declare const defaultLicenseConfig: (spdx: SPDXLicenseIdentifier, copyrightHolder: string) => LicenseConfig;
+/**
+ * Write license configuration to the aws nx plugin config
+ */
+export declare const writeLicenseConfig: (tree: Tree, spdx: SPDXLicenseIdentifier, config: LicenseConfig) => Promise<void>;
+/**
+ * Read license configuration
+ */
+export declare const readLicenseConfig: (tree: Tree) => Promise<LicenseConfig | undefined>;