repopo 0.7.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +187 -6
- package/THIRD-PARTY-LICENSES.txt +149 -3
- package/esm/adapters/fluidFramework.d.ts +103 -0
- package/esm/adapters/fluidFramework.d.ts.map +1 -0
- package/esm/adapters/fluidFramework.js +119 -0
- package/esm/adapters/fluidFramework.js.map +1 -0
- package/esm/baseCommand.d.ts +1 -0
- package/esm/baseCommand.d.ts.map +1 -1
- package/esm/baseCommand.js +2 -1
- package/esm/baseCommand.js.map +1 -1
- package/esm/commands/check.d.ts.map +1 -1
- package/esm/commands/check.js +9 -8
- package/esm/commands/check.js.map +1 -1
- package/esm/index.d.ts +1 -0
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +1 -0
- package/esm/index.js.map +1 -1
- package/esm/perf.d.ts +4 -1
- package/esm/perf.d.ts.map +1 -1
- package/esm/perf.js +3 -2
- package/esm/perf.js.map +1 -1
- package/esm/policies/LicenseFileExists.d.ts.map +1 -1
- package/esm/policies/LicenseFileExists.js +3 -1
- package/esm/policies/LicenseFileExists.js.map +1 -1
- package/esm/policies/NoJsFileExtensions.d.ts.map +1 -1
- package/esm/policies/NoJsFileExtensions.js +4 -1
- package/esm/policies/NoJsFileExtensions.js.map +1 -1
- package/esm/policies/NoLargeBinaryFiles.d.ts.map +1 -1
- package/esm/policies/NoLargeBinaryFiles.js +3 -1
- package/esm/policies/NoLargeBinaryFiles.js.map +1 -1
- package/esm/policies/NoPrivateWorkspaceDependencies.d.ts +37 -0
- package/esm/policies/NoPrivateWorkspaceDependencies.d.ts.map +1 -0
- package/esm/policies/NoPrivateWorkspaceDependencies.js +137 -0
- package/esm/policies/NoPrivateWorkspaceDependencies.js.map +1 -0
- package/esm/policies/PackageAllowedScopes.d.ts +88 -0
- package/esm/policies/PackageAllowedScopes.d.ts.map +1 -0
- package/esm/policies/PackageAllowedScopes.js +113 -0
- package/esm/policies/PackageAllowedScopes.js.map +1 -0
- package/esm/policies/PackageEsmType.d.ts +100 -0
- package/esm/policies/PackageEsmType.d.ts.map +1 -0
- package/esm/policies/PackageEsmType.js +257 -0
- package/esm/policies/PackageEsmType.js.map +1 -0
- package/esm/policies/PackageFolderName.d.ts +97 -0
- package/esm/policies/PackageFolderName.d.ts.map +1 -0
- package/esm/policies/PackageFolderName.js +104 -0
- package/esm/policies/PackageFolderName.js.map +1 -0
- package/esm/policies/PackageJsonProperties.d.ts.map +1 -1
- package/esm/policies/PackageJsonProperties.js +2 -1
- package/esm/policies/PackageJsonProperties.js.map +1 -1
- package/esm/policies/PackageJsonRepoDirectoryProperty.d.ts.map +1 -1
- package/esm/policies/PackageJsonRepoDirectoryProperty.js +4 -3
- package/esm/policies/PackageJsonRepoDirectoryProperty.js.map +1 -1
- package/esm/policies/PackageJsonSorted.d.ts.map +1 -1
- package/esm/policies/PackageJsonSorted.js +11 -3
- package/esm/policies/PackageJsonSorted.js.map +1 -1
- package/esm/policies/PackageLicense.d.ts +61 -0
- package/esm/policies/PackageLicense.d.ts.map +1 -0
- package/esm/policies/PackageLicense.js +131 -0
- package/esm/policies/PackageLicense.js.map +1 -0
- package/esm/policies/PackagePrivateField.d.ts +124 -0
- package/esm/policies/PackagePrivateField.d.ts.map +1 -0
- package/esm/policies/PackagePrivateField.js +155 -0
- package/esm/policies/PackagePrivateField.js.map +1 -0
- package/esm/policies/PackageReadme.d.ts +77 -0
- package/esm/policies/PackageReadme.d.ts.map +1 -0
- package/esm/policies/PackageReadme.js +209 -0
- package/esm/policies/PackageReadme.js.map +1 -0
- package/esm/policies/PackageScripts.d.ts +180 -2
- package/esm/policies/PackageScripts.d.ts.map +1 -1
- package/esm/policies/PackageScripts.js +349 -29
- package/esm/policies/PackageScripts.js.map +1 -1
- package/esm/policies/PackageTestScripts.d.ts +100 -0
- package/esm/policies/PackageTestScripts.d.ts.map +1 -0
- package/esm/policies/PackageTestScripts.js +149 -0
- package/esm/policies/PackageTestScripts.js.map +1 -0
- package/esm/policies/RequiredGitignorePatterns.d.ts.map +1 -1
- package/esm/policies/RequiredGitignorePatterns.js +10 -4
- package/esm/policies/RequiredGitignorePatterns.js.map +1 -1
- package/esm/policies.d.ts +9 -1
- package/esm/policies.d.ts.map +1 -1
- package/esm/policies.js +10 -1
- package/esm/policies.js.map +1 -1
- package/esm/policy.d.ts +5 -1
- package/esm/policy.d.ts.map +1 -1
- package/esm/policy.js.map +1 -1
- package/esm/policyDefiners/defineFileHeaderPolicy.d.ts.map +1 -1
- package/esm/policyDefiners/defineFileHeaderPolicy.js +2 -1
- package/esm/policyDefiners/defineFileHeaderPolicy.js.map +1 -1
- package/esm/policyDefiners/definePackagePolicy.d.ts.map +1 -1
- package/esm/policyDefiners/definePackagePolicy.js +2 -1
- package/esm/policyDefiners/definePackagePolicy.js.map +1 -1
- package/esm/tsdoc-metadata.json +1 -1
- package/esm/utils/indentation.d.ts +73 -0
- package/esm/utils/indentation.d.ts.map +1 -0
- package/esm/utils/indentation.js +97 -0
- package/esm/utils/indentation.js.map +1 -0
- package/esm/utils/packageName.d.ts +71 -0
- package/esm/utils/packageName.d.ts.map +1 -0
- package/esm/utils/packageName.js +79 -0
- package/esm/utils/packageName.js.map +1 -0
- package/oclif.manifest.json +1 -1
- package/package.json +30 -15
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Configuration for the PackageFolderName policy.
|
|
3
|
+
*
|
|
4
|
+
* This policy ensures that package folder names match their package names,
|
|
5
|
+
* promoting consistency and making packages easier to find in the file system.
|
|
6
|
+
*
|
|
7
|
+
* @example
|
|
8
|
+
* ```typescript
|
|
9
|
+
* const config: PackageFolderNameConfig = {
|
|
10
|
+
* // Strip all scopes when matching folder names
|
|
11
|
+
* stripScopes: ["@*"],
|
|
12
|
+
* // Or strip specific scopes
|
|
13
|
+
* stripScopes: ["@myorg", "@internal"],
|
|
14
|
+
* // These packages are exempt from the check
|
|
15
|
+
* excludePackages: ["@myorg/special-name"],
|
|
16
|
+
* };
|
|
17
|
+
* ```
|
|
18
|
+
*
|
|
19
|
+
* @alpha
|
|
20
|
+
*/
|
|
21
|
+
export interface PackageFolderNameConfig {
|
|
22
|
+
/**
|
|
23
|
+
* A list of npm scope patterns to strip when comparing folder names to package names.
|
|
24
|
+
*
|
|
25
|
+
* For scoped packages like `@myorg/my-package`, if `@myorg` matches a pattern in this list,
|
|
26
|
+
* the policy will expect the folder to be named `my-package` (not `@myorg/my-package`).
|
|
27
|
+
*
|
|
28
|
+
* @remarks
|
|
29
|
+
*
|
|
30
|
+
* Supports glob patterns:
|
|
31
|
+
* - `@*` - matches all scopes
|
|
32
|
+
* - `@myorg` - matches exactly `@myorg`
|
|
33
|
+
* - `@my*` - matches scopes starting with `@my`
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* ```typescript
|
|
37
|
+
* // Strip all scopes - @anything/my-package → folder "my-package"
|
|
38
|
+
* stripScopes: ["@*"]
|
|
39
|
+
*
|
|
40
|
+
* // Strip specific scopes only
|
|
41
|
+
* stripScopes: ["@myorg", "@internal"]
|
|
42
|
+
*
|
|
43
|
+
* // Strip scopes matching a pattern
|
|
44
|
+
* stripScopes: ["@fluid*"]
|
|
45
|
+
* ```
|
|
46
|
+
*/
|
|
47
|
+
stripScopes?: string[];
|
|
48
|
+
/**
|
|
49
|
+
* A list of package names that are exempt from folder name matching.
|
|
50
|
+
*
|
|
51
|
+
* Use this for packages that intentionally have different folder names,
|
|
52
|
+
* such as legacy packages or packages with special naming requirements.
|
|
53
|
+
*
|
|
54
|
+
* @example
|
|
55
|
+
* ```typescript
|
|
56
|
+
* excludePackages: ["@myorg/cli", "legacy-package"]
|
|
57
|
+
* ```
|
|
58
|
+
*/
|
|
59
|
+
excludePackages?: string[];
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* A policy that ensures package folder names match package names.
|
|
63
|
+
*
|
|
64
|
+
* This policy helps maintain a consistent and predictable file structure
|
|
65
|
+
* in monorepos by ensuring that folder names correspond to package names.
|
|
66
|
+
* This makes it easier to locate packages in the file system.
|
|
67
|
+
*
|
|
68
|
+
* @remarks
|
|
69
|
+
*
|
|
70
|
+
* The policy compares the immediate parent folder name of the package.json
|
|
71
|
+
* against the package name. For scoped packages, the scope can optionally
|
|
72
|
+
* be stripped based on the `stripScopes` configuration.
|
|
73
|
+
*
|
|
74
|
+
* For example:
|
|
75
|
+
* - `packages/my-lib/package.json` with name `my-lib` ✓
|
|
76
|
+
* - `packages/my-lib/package.json` with name `@myorg/my-lib` ✓ (if @myorg in stripScopes)
|
|
77
|
+
* - `packages/wrong-name/package.json` with name `my-lib` ✗
|
|
78
|
+
*
|
|
79
|
+
* @example
|
|
80
|
+
* ```typescript
|
|
81
|
+
* import { makePolicy } from "repopo";
|
|
82
|
+
* import { PackageFolderName } from "repopo/policies";
|
|
83
|
+
*
|
|
84
|
+
* const config: RepopoConfig = {
|
|
85
|
+
* policies: [
|
|
86
|
+
* makePolicy(PackageFolderName, {
|
|
87
|
+
* stripScopes: ["@myorg", "@internal"],
|
|
88
|
+
* excludePackages: ["@myorg/special-case"],
|
|
89
|
+
* }),
|
|
90
|
+
* ],
|
|
91
|
+
* };
|
|
92
|
+
* ```
|
|
93
|
+
*
|
|
94
|
+
* @alpha
|
|
95
|
+
*/
|
|
96
|
+
export declare const PackageFolderName: import("../policy.js").PolicyDefinition<PackageFolderNameConfig | undefined>;
|
|
97
|
+
//# sourceMappingURL=PackageFolderName.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PackageFolderName.d.ts","sourceRoot":"","sources":["../../src/policies/PackageFolderName.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,uBAAuB;IACvC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IAEvB;;;;;;;;;;OAUG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B;AAuCD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,eAAO,MAAM,iBAAiB,8EAgD5B,CAAC"}
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import path from "pathe";
|
|
2
|
+
import picomatch from "picomatch";
|
|
3
|
+
import { definePackagePolicy } from "../policyDefiners/definePackagePolicy.js";
|
|
4
|
+
import { parsePackageName } from "../utils/packageName.js";
|
|
5
|
+
/**
|
|
6
|
+
* Check if a scope should be stripped based on the patterns.
|
|
7
|
+
*
|
|
8
|
+
* @param scope - The scope to check (e.g., `@myorg`)
|
|
9
|
+
* @param stripScopes - List of scope patterns to match (supports glob patterns via picomatch)
|
|
10
|
+
* @returns `true` if the scope matches any pattern
|
|
11
|
+
*/
|
|
12
|
+
function shouldStripScope(scope, stripScopes) {
|
|
13
|
+
if (stripScopes.length === 0) {
|
|
14
|
+
return false;
|
|
15
|
+
}
|
|
16
|
+
return picomatch.isMatch(scope, stripScopes);
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Get the expected folder name from a package name.
|
|
20
|
+
*
|
|
21
|
+
* @param packageName - The package name (e.g., `@myorg/my-package`)
|
|
22
|
+
* @param stripScopes - Scope patterns to strip from the package name
|
|
23
|
+
* @returns The expected folder name
|
|
24
|
+
*/
|
|
25
|
+
function getExpectedFolderName(packageName, stripScopes) {
|
|
26
|
+
const { scope, unscopedName } = parsePackageName(packageName);
|
|
27
|
+
// Check if the package is scoped and should have scope stripped
|
|
28
|
+
if (scope !== undefined && shouldStripScope(scope, stripScopes)) {
|
|
29
|
+
return unscopedName;
|
|
30
|
+
}
|
|
31
|
+
// Return full package name for unscoped packages or scopes not in stripScopes
|
|
32
|
+
return packageName;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* A policy that ensures package folder names match package names.
|
|
36
|
+
*
|
|
37
|
+
* This policy helps maintain a consistent and predictable file structure
|
|
38
|
+
* in monorepos by ensuring that folder names correspond to package names.
|
|
39
|
+
* This makes it easier to locate packages in the file system.
|
|
40
|
+
*
|
|
41
|
+
* @remarks
|
|
42
|
+
*
|
|
43
|
+
* The policy compares the immediate parent folder name of the package.json
|
|
44
|
+
* against the package name. For scoped packages, the scope can optionally
|
|
45
|
+
* be stripped based on the `stripScopes` configuration.
|
|
46
|
+
*
|
|
47
|
+
* For example:
|
|
48
|
+
* - `packages/my-lib/package.json` with name `my-lib` ✓
|
|
49
|
+
* - `packages/my-lib/package.json` with name `@myorg/my-lib` ✓ (if @myorg in stripScopes)
|
|
50
|
+
* - `packages/wrong-name/package.json` with name `my-lib` ✗
|
|
51
|
+
*
|
|
52
|
+
* @example
|
|
53
|
+
* ```typescript
|
|
54
|
+
* import { makePolicy } from "repopo";
|
|
55
|
+
* import { PackageFolderName } from "repopo/policies";
|
|
56
|
+
*
|
|
57
|
+
* const config: RepopoConfig = {
|
|
58
|
+
* policies: [
|
|
59
|
+
* makePolicy(PackageFolderName, {
|
|
60
|
+
* stripScopes: ["@myorg", "@internal"],
|
|
61
|
+
* excludePackages: ["@myorg/special-case"],
|
|
62
|
+
* }),
|
|
63
|
+
* ],
|
|
64
|
+
* };
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
67
|
+
* @alpha
|
|
68
|
+
*/
|
|
69
|
+
export const PackageFolderName = definePackagePolicy("PackageFolderName", async (json, { file, config }) => {
|
|
70
|
+
// If no config provided, use defaults (check all packages)
|
|
71
|
+
const effectiveConfig = config ?? {};
|
|
72
|
+
const packageName = json.name;
|
|
73
|
+
// Skip packages without a name
|
|
74
|
+
if (packageName === undefined) {
|
|
75
|
+
return true;
|
|
76
|
+
}
|
|
77
|
+
// Skip the root package (common in monorepos)
|
|
78
|
+
if (packageName === "root") {
|
|
79
|
+
return true;
|
|
80
|
+
}
|
|
81
|
+
// Skip explicitly excluded packages
|
|
82
|
+
if (effectiveConfig.excludePackages?.includes(packageName)) {
|
|
83
|
+
return true;
|
|
84
|
+
}
|
|
85
|
+
// Get the folder name (parent directory of package.json)
|
|
86
|
+
const folderName = path.basename(path.dirname(file));
|
|
87
|
+
// Get the expected folder name
|
|
88
|
+
const expectedFolderName = getExpectedFolderName(packageName, effectiveConfig.stripScopes ?? []);
|
|
89
|
+
// Compare folder name to expected name
|
|
90
|
+
if (folderName === expectedFolderName) {
|
|
91
|
+
return true;
|
|
92
|
+
}
|
|
93
|
+
// Mismatch - build error message
|
|
94
|
+
const failResult = {
|
|
95
|
+
name: PackageFolderName.name,
|
|
96
|
+
file,
|
|
97
|
+
autoFixable: false, // Can't auto-fix folder names
|
|
98
|
+
errorMessages: [
|
|
99
|
+
`Package folder "${folderName}" does not match package name "${packageName}". Expected folder name: "${expectedFolderName}"`,
|
|
100
|
+
],
|
|
101
|
+
};
|
|
102
|
+
return failResult;
|
|
103
|
+
});
|
|
104
|
+
//# sourceMappingURL=PackageFolderName.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PackageFolderName.js","sourceRoot":"","sources":["../../src/policies/PackageFolderName.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,OAAO,CAAC;AACzB,OAAO,SAAS,MAAM,WAAW,CAAC;AAGlC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAgE3D;;;;;;GAMG;AACH,SAAS,gBAAgB,CAAC,KAAa,EAAE,WAAqB;IAC7D,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACd,CAAC;IAED,OAAO,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;AAC9C,CAAC;AAED;;;;;;GAMG;AACH,SAAS,qBAAqB,CAC7B,WAAmB,EACnB,WAAqB;IAErB,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAE9D,gEAAgE;IAChE,IAAI,KAAK,KAAK,SAAS,IAAI,gBAAgB,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE,CAAC;QACjE,OAAO,YAAY,CAAC;IACrB,CAAC;IAED,8EAA8E;IAC9E,OAAO,WAAW,CAAC;AACpB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,mBAAmB,CAGlD,mBAAmB,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE;IACvD,2DAA2D;IAC3D,MAAM,eAAe,GAAG,MAAM,IAAI,EAAE,CAAC;IAErC,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC;IAE9B,+BAA+B;IAC/B,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC;IACb,CAAC;IAED,8CAA8C;IAC9C,IAAI,WAAW,KAAK,MAAM,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IACb,CAAC;IAED,oCAAoC;IACpC,IAAI,eAAe,CAAC,eAAe,EAAE,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC;IACb,CAAC;IAED,yDAAyD;IACzD,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAErD,+BAA+B;IAC/B,MAAM,kBAAkB,GAAG,qBAAqB,CAC/C,WAAW,EACX,eAAe,CAAC,WAAW,IAAI,EAAE,CACjC,CAAC;IAEF,uCAAuC;IACvC,IAAI,UAAU,KAAK,kBAAkB,EAAE,CAAC;QACvC,OAAO,IAAI,CAAC;IACb,CAAC;IAED,iCAAiC;IACjC,MAAM,UAAU,GAAkB;QACjC,IAAI,EAAE,iBAAiB,CAAC,IAAI;QAC5B,IAAI;QACJ,WAAW,EAAE,KAAK,EAAE,8BAA8B;QAClD,aAAa,EAAE;YACd,mBAAmB,UAAU,kCAAkC,WAAW,6BAA6B,kBAAkB,GAAG;SAC5H;KACD,CAAC;IACF,OAAO,UAAU,CAAC;AACnB,CAAC,CAAC,CAAC","sourcesContent":["import path from \"pathe\";\nimport picomatch from \"picomatch\";\nimport type { PackageJson } from \"type-fest\";\nimport type { PolicyFailure } from \"../policy.js\";\nimport { definePackagePolicy } from \"../policyDefiners/definePackagePolicy.js\";\nimport { parsePackageName } from \"../utils/packageName.js\";\n\n/**\n * Configuration for the PackageFolderName policy.\n *\n * This policy ensures that package folder names match their package names,\n * promoting consistency and making packages easier to find in the file system.\n *\n * @example\n * ```typescript\n * const config: PackageFolderNameConfig = {\n * // Strip all scopes when matching folder names\n * stripScopes: [\"@*\"],\n * // Or strip specific scopes\n * stripScopes: [\"@myorg\", \"@internal\"],\n * // These packages are exempt from the check\n * excludePackages: [\"@myorg/special-name\"],\n * };\n * ```\n *\n * @alpha\n */\nexport interface PackageFolderNameConfig {\n\t/**\n\t * A list of npm scope patterns to strip when comparing folder names to package names.\n\t *\n\t * For scoped packages like `@myorg/my-package`, if `@myorg` matches a pattern in this list,\n\t * the policy will expect the folder to be named `my-package` (not `@myorg/my-package`).\n\t *\n\t * @remarks\n\t *\n\t * Supports glob patterns:\n\t * - `@*` - matches all scopes\n\t * - `@myorg` - matches exactly `@myorg`\n\t * - `@my*` - matches scopes starting with `@my`\n\t *\n\t * @example\n\t * ```typescript\n\t * // Strip all scopes - @anything/my-package → folder \"my-package\"\n\t * stripScopes: [\"@*\"]\n\t *\n\t * // Strip specific scopes only\n\t * stripScopes: [\"@myorg\", \"@internal\"]\n\t *\n\t * // Strip scopes matching a pattern\n\t * stripScopes: [\"@fluid*\"]\n\t * ```\n\t */\n\tstripScopes?: string[];\n\n\t/**\n\t * A list of package names that are exempt from folder name matching.\n\t *\n\t * Use this for packages that intentionally have different folder names,\n\t * such as legacy packages or packages with special naming requirements.\n\t *\n\t * @example\n\t * ```typescript\n\t * excludePackages: [\"@myorg/cli\", \"legacy-package\"]\n\t * ```\n\t */\n\texcludePackages?: string[];\n}\n\n/**\n * Check if a scope should be stripped based on the patterns.\n *\n * @param scope - The scope to check (e.g., `@myorg`)\n * @param stripScopes - List of scope patterns to match (supports glob patterns via picomatch)\n * @returns `true` if the scope matches any pattern\n */\nfunction shouldStripScope(scope: string, stripScopes: string[]): boolean {\n\tif (stripScopes.length === 0) {\n\t\treturn false;\n\t}\n\n\treturn picomatch.isMatch(scope, stripScopes);\n}\n\n/**\n * Get the expected folder name from a package name.\n *\n * @param packageName - The package name (e.g., `@myorg/my-package`)\n * @param stripScopes - Scope patterns to strip from the package name\n * @returns The expected folder name\n */\nfunction getExpectedFolderName(\n\tpackageName: string,\n\tstripScopes: string[],\n): string {\n\tconst { scope, unscopedName } = parsePackageName(packageName);\n\n\t// Check if the package is scoped and should have scope stripped\n\tif (scope !== undefined && shouldStripScope(scope, stripScopes)) {\n\t\treturn unscopedName;\n\t}\n\n\t// Return full package name for unscoped packages or scopes not in stripScopes\n\treturn packageName;\n}\n\n/**\n * A policy that ensures package folder names match package names.\n *\n * This policy helps maintain a consistent and predictable file structure\n * in monorepos by ensuring that folder names correspond to package names.\n * This makes it easier to locate packages in the file system.\n *\n * @remarks\n *\n * The policy compares the immediate parent folder name of the package.json\n * against the package name. For scoped packages, the scope can optionally\n * be stripped based on the `stripScopes` configuration.\n *\n * For example:\n * - `packages/my-lib/package.json` with name `my-lib` ✓\n * - `packages/my-lib/package.json` with name `@myorg/my-lib` ✓ (if @myorg in stripScopes)\n * - `packages/wrong-name/package.json` with name `my-lib` ✗\n *\n * @example\n * ```typescript\n * import { makePolicy } from \"repopo\";\n * import { PackageFolderName } from \"repopo/policies\";\n *\n * const config: RepopoConfig = {\n * policies: [\n * makePolicy(PackageFolderName, {\n * stripScopes: [\"@myorg\", \"@internal\"],\n * excludePackages: [\"@myorg/special-case\"],\n * }),\n * ],\n * };\n * ```\n *\n * @alpha\n */\nexport const PackageFolderName = definePackagePolicy<\n\tPackageJson,\n\tPackageFolderNameConfig | undefined\n>(\"PackageFolderName\", async (json, { file, config }) => {\n\t// If no config provided, use defaults (check all packages)\n\tconst effectiveConfig = config ?? {};\n\n\tconst packageName = json.name;\n\n\t// Skip packages without a name\n\tif (packageName === undefined) {\n\t\treturn true;\n\t}\n\n\t// Skip the root package (common in monorepos)\n\tif (packageName === \"root\") {\n\t\treturn true;\n\t}\n\n\t// Skip explicitly excluded packages\n\tif (effectiveConfig.excludePackages?.includes(packageName)) {\n\t\treturn true;\n\t}\n\n\t// Get the folder name (parent directory of package.json)\n\tconst folderName = path.basename(path.dirname(file));\n\n\t// Get the expected folder name\n\tconst expectedFolderName = getExpectedFolderName(\n\t\tpackageName,\n\t\teffectiveConfig.stripScopes ?? [],\n\t);\n\n\t// Compare folder name to expected name\n\tif (folderName === expectedFolderName) {\n\t\treturn true;\n\t}\n\n\t// Mismatch - build error message\n\tconst failResult: PolicyFailure = {\n\t\tname: PackageFolderName.name,\n\t\tfile,\n\t\tautoFixable: false, // Can't auto-fix folder names\n\t\terrorMessages: [\n\t\t\t`Package folder \"${folderName}\" does not match package name \"${packageName}\". Expected folder name: \"${expectedFolderName}\"`,\n\t\t],\n\t};\n\treturn failResult;\n});\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PackageJsonProperties.d.ts","sourceRoot":"","sources":["../../src/policies/PackageJsonProperties.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAM7C;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC7C;;OAEG;IACH,QAAQ,EAAE,WAAW,CAAC;CACtB;AAED;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,
|
|
1
|
+
{"version":3,"file":"PackageJsonProperties.d.ts","sourceRoot":"","sources":["../../src/policies/PackageJsonProperties.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAM7C;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC7C;;OAEG;IACH,QAAQ,EAAE,WAAW,CAAC;CACtB;AAED;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,oFA6ChC,CAAC"}
|
|
@@ -17,6 +17,7 @@ export const PackageJsonProperties = definePackagePolicy("PackageJsonProperties"
|
|
|
17
17
|
name: PackageJsonProperties.name,
|
|
18
18
|
file,
|
|
19
19
|
autoFixable: true,
|
|
20
|
+
errorMessages: [],
|
|
20
21
|
};
|
|
21
22
|
const merged = defu(verbatim, json);
|
|
22
23
|
const result = diff(merged, json);
|
|
@@ -35,7 +36,7 @@ export const PackageJsonProperties = definePackagePolicy("PackageJsonProperties"
|
|
|
35
36
|
return fixResult;
|
|
36
37
|
}
|
|
37
38
|
// There were errors, and we're not resolving them, so return a fail result
|
|
38
|
-
failResult.
|
|
39
|
+
failResult.errorMessages = messages;
|
|
39
40
|
return failResult;
|
|
40
41
|
}
|
|
41
42
|
return true;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PackageJsonProperties.js","sourceRoot":"","sources":["../../src/policies/PackageJsonProperties.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,IAAI,MAAM,WAAW,CAAC;AAG7B,OAAO,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AAE/E,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,QAAQ,CAAC;AAc1C;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,mBAAmB,CAGtD,uBAAuB,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE;IACpE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC;IACb,CAAC;IACD,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAE5B,MAAM,UAAU,GAAkB;QACjC,IAAI,EAAE,qBAAqB,CAAC,IAAI;QAChC,IAAI;QACJ,WAAW,EAAE,IAAI;KACjB,CAAC;IAEF,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACpC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAElC,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,KAAK,MAAM,UAAU,IAAI,MAAM,EAAE,CAAC;QACjC,QAAQ,CAAC,IAAI,CACZ,2CAA2C,UAAU,CAAC,IAAI,IAAI,CAC9D,CAAC;IACH,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzB,IAAI,OAAO,EAAE,CAAC;YACb,MAAM,SAAS,GAAoB;gBAClC,GAAG,UAAU;gBACb,QAAQ,EAAE,KAAK;aACf,CAAC;YAEF,MAAM,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;YAEhD,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAC;YAC1B,OAAO,SAAS,CAAC;QAClB,CAAC;QAED,2EAA2E;QAC3E,UAAU,CAAC,
|
|
1
|
+
{"version":3,"file":"PackageJsonProperties.js","sourceRoot":"","sources":["../../src/policies/PackageJsonProperties.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,IAAI,MAAM,WAAW,CAAC;AAG7B,OAAO,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AAE/E,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,QAAQ,CAAC;AAc1C;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,mBAAmB,CAGtD,uBAAuB,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE;IACpE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC;IACb,CAAC;IACD,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAE5B,MAAM,UAAU,GAAkB;QACjC,IAAI,EAAE,qBAAqB,CAAC,IAAI;QAChC,IAAI;QACJ,WAAW,EAAE,IAAI;QACjB,aAAa,EAAE,EAAE;KACjB,CAAC;IAEF,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACpC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAElC,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,KAAK,MAAM,UAAU,IAAI,MAAM,EAAE,CAAC;QACjC,QAAQ,CAAC,IAAI,CACZ,2CAA2C,UAAU,CAAC,IAAI,IAAI,CAC9D,CAAC;IACH,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzB,IAAI,OAAO,EAAE,CAAC;YACb,MAAM,SAAS,GAAoB;gBAClC,GAAG,UAAU;gBACb,QAAQ,EAAE,KAAK;aACf,CAAC;YAEF,MAAM,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;YAEhD,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAC;YAC1B,OAAO,SAAS,CAAC;QAClB,CAAC;QAED,2EAA2E;QAC3E,UAAU,CAAC,aAAa,GAAG,QAAQ,CAAC;QACpC,OAAO,UAAU,CAAC;IACnB,CAAC;IAED,OAAO,IAAI,CAAC;AACb,CAAC,CAAC,CAAC","sourcesContent":["import { defu } from \"defu\";\nimport jsonfile from \"jsonfile\";\nimport diff from \"microdiff\";\nimport type { PackageJson } from \"type-fest\";\nimport type { PolicyFailure, PolicyFixResult } from \"../policy.js\";\nimport { definePackagePolicy } from \"../policyDefiners/definePackagePolicy.js\";\n\nconst { writeFile: writeJson } = jsonfile;\n\n/**\n * Policy settings for the PackageJsonProperties repo policy.\n *\n * @alpha\n */\nexport interface PackageJsonPropertiesSettings {\n\t/**\n\t * Sets a package.json property to the value provided. The value will be used verbatim.\n\t */\n\tverbatim: PackageJson;\n}\n\n/**\n * A RepoPolicy that checks that package.json properties in packages match expected values.\n *\n * @alpha\n */\nexport const PackageJsonProperties = definePackagePolicy<\n\tPackageJson,\n\tPackageJsonPropertiesSettings | undefined\n>(\"PackageJsonProperties\", async (json, { file, config, resolve }) => {\n\tif (config === undefined) {\n\t\treturn true;\n\t}\n\tconst { verbatim } = config;\n\n\tconst failResult: PolicyFailure = {\n\t\tname: PackageJsonProperties.name,\n\t\tfile,\n\t\tautoFixable: true,\n\t\terrorMessages: [],\n\t};\n\n\tconst merged = defu(verbatim, json);\n\tconst result = diff(merged, json);\n\n\tconst messages: string[] = [];\n\tfor (const diffResult of result) {\n\t\tmessages.push(\n\t\t\t`Incorrect package.json field value for '${diffResult.path}'.`,\n\t\t);\n\t}\n\n\tif (messages.length > 0) {\n\t\tif (resolve) {\n\t\t\tconst fixResult: PolicyFixResult = {\n\t\t\t\t...failResult,\n\t\t\t\tresolved: false,\n\t\t\t};\n\n\t\t\tawait writeJson(file, merged, { spaces: \"\\t\" });\n\n\t\t\tfixResult.resolved = true;\n\t\t\treturn fixResult;\n\t\t}\n\n\t\t// There were errors, and we're not resolving them, so return a fail result\n\t\tfailResult.errorMessages = messages;\n\t\treturn failResult;\n\t}\n\n\treturn true;\n});\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PackageJsonRepoDirectoryProperty.d.ts","sourceRoot":"","sources":["../../src/policies/PackageJsonRepoDirectoryProperty.ts"],"names":[],"mappings":"AAOA;;;;;GAKG;AACH,eAAO,MAAM,gCAAgC,
|
|
1
|
+
{"version":3,"file":"PackageJsonRepoDirectoryProperty.d.ts","sourceRoot":"","sources":["../../src/policies/PackageJsonRepoDirectoryProperty.ts"],"names":[],"mappings":"AAOA;;;;;GAKG;AACH,eAAO,MAAM,gCAAgC,oDAmD3C,CAAC"}
|
|
@@ -13,12 +13,13 @@ export const PackageJsonRepoDirectoryProperty = definePackagePolicy("PackageJson
|
|
|
13
13
|
name: PackageJsonRepoDirectoryProperty.name,
|
|
14
14
|
file,
|
|
15
15
|
autoFixable: true,
|
|
16
|
+
errorMessages: [],
|
|
16
17
|
};
|
|
17
18
|
const fixResult = {
|
|
18
19
|
...failResult,
|
|
19
20
|
resolved: false,
|
|
20
21
|
};
|
|
21
|
-
const pkgDir = path.dirname(file);
|
|
22
|
+
const pkgDir = path.dirname(path.resolve(root, file));
|
|
22
23
|
const maybeDir = path.relative(root, pkgDir);
|
|
23
24
|
const relativePkgDir = maybeDir === "" ? undefined : maybeDir;
|
|
24
25
|
if (typeof json.repository === "object" &&
|
|
@@ -39,11 +40,11 @@ export const PackageJsonRepoDirectoryProperty = definePackagePolicy("PackageJson
|
|
|
39
40
|
}
|
|
40
41
|
catch (error) {
|
|
41
42
|
fixResult.resolved = false;
|
|
42
|
-
fixResult.
|
|
43
|
+
fixResult.errorMessages.push(`${error.message}\n${error.stack}`);
|
|
43
44
|
}
|
|
44
45
|
return fixResult;
|
|
45
46
|
}
|
|
46
|
-
failResult.
|
|
47
|
+
failResult.errorMessages.push(`repository.directory value is wrong. Expected '${relativePkgDir}', got '${json.repository.directory}'`);
|
|
47
48
|
return failResult;
|
|
48
49
|
}
|
|
49
50
|
return true;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PackageJsonRepoDirectoryProperty.js","sourceRoot":"","sources":["../../src/policies/PackageJsonRepoDirectoryProperty.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,IAAI,MAAM,OAAO,CAAC;AAGzB,OAAO,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AAE/E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,mBAAmB,CAGjE,kCAAkC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE;IAC7E,MAAM,UAAU,GAAkB;QACjC,IAAI,EAAE,gCAAgC,CAAC,IAAI;QAC3C,IAAI;QACJ,WAAW,EAAE,IAAI;KACjB,CAAC;IAEF,MAAM,SAAS,GAAoB;QAClC,GAAG,UAAU;QACb,QAAQ,EAAE,KAAK;KACf,CAAC;IAEF,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"PackageJsonRepoDirectoryProperty.js","sourceRoot":"","sources":["../../src/policies/PackageJsonRepoDirectoryProperty.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,IAAI,MAAM,OAAO,CAAC;AAGzB,OAAO,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AAE/E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,mBAAmB,CAGjE,kCAAkC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE;IAC7E,MAAM,UAAU,GAAkB;QACjC,IAAI,EAAE,gCAAgC,CAAC,IAAI;QAC3C,IAAI;QACJ,WAAW,EAAE,IAAI;QACjB,aAAa,EAAE,EAAE;KACjB,CAAC;IAEF,MAAM,SAAS,GAAoB;QAClC,GAAG,UAAU;QACb,QAAQ,EAAE,KAAK;KACf,CAAC;IAEF,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IACtD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC7C,MAAM,cAAc,GAAG,QAAQ,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC;IAE9D,IACC,OAAO,IAAI,CAAC,UAAU,KAAK,QAAQ;QACnC,IAAI,CAAC,UAAU,CAAC,SAAS,KAAK,cAAc,EAC3C,CAAC;QACF,IAAI,OAAO,EAAE,CAAC;YACb,IAAI,CAAC;gBACJ,uEAAuE;gBACvE,qBAAqB,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE;oBACpC,MAAM,CAAC,OAAO,IAAI,CAAC,UAAU,KAAK,QAAQ,CAAC,CAAC;oBAC5C,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;wBAClC,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;oBAClC,CAAC;yBAAM,CAAC;wBACP,IAAI,CAAC,UAAU,CAAC,SAAS,GAAG,cAAc,CAAC;oBAC5C,CAAC;gBACF,CAAC,CAAC,CAAC;gBACH,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAC;YAC3B,CAAC;YAAC,OAAO,KAAc,EAAE,CAAC;gBACzB,SAAS,CAAC,QAAQ,GAAG,KAAK,CAAC;gBAC3B,SAAS,CAAC,aAAa,CAAC,IAAI,CAC3B,GAAI,KAAe,CAAC,OAAO,KAAM,KAAe,CAAC,KAAK,EAAE,CACxD,CAAC;YACH,CAAC;YACD,OAAO,SAAS,CAAC;QAClB,CAAC;QACD,UAAU,CAAC,aAAa,CAAC,IAAI,CAC5B,kDAAkD,cAAc,WAAW,IAAI,CAAC,UAAU,CAAC,SAAS,GAAG,CACvG,CAAC;QACF,OAAO,UAAU,CAAC;IACnB,CAAC;IAED,OAAO,IAAI,CAAC;AACb,CAAC,CAAC,CAAC","sourcesContent":["import assert from \"node:assert/strict\";\nimport { updatePackageJsonFile } from \"@fluid-tools/build-infrastructure\";\nimport path from \"pathe\";\nimport type { PackageJson } from \"type-fest\";\nimport type { PolicyFailure, PolicyFixResult } from \"../policy.js\";\nimport { definePackagePolicy } from \"../policyDefiners/definePackagePolicy.js\";\n\n/**\n * A RepoPolicy that checks that the repository.directory property in package.json is set correctly. If the repository\n * field is a string instead of an object the package will be ignored.\n *\n * @alpha\n */\nexport const PackageJsonRepoDirectoryProperty = definePackagePolicy<\n\tPackageJson,\n\tundefined\n>(\"PackageJsonRepoDirectoryProperty\", async (json, { file, root, resolve }) => {\n\tconst failResult: PolicyFailure = {\n\t\tname: PackageJsonRepoDirectoryProperty.name,\n\t\tfile,\n\t\tautoFixable: true,\n\t\terrorMessages: [],\n\t};\n\n\tconst fixResult: PolicyFixResult = {\n\t\t...failResult,\n\t\tresolved: false,\n\t};\n\n\tconst pkgDir = path.dirname(path.resolve(root, file));\n\tconst maybeDir = path.relative(root, pkgDir);\n\tconst relativePkgDir = maybeDir === \"\" ? undefined : maybeDir;\n\n\tif (\n\t\ttypeof json.repository === \"object\" &&\n\t\tjson.repository.directory !== relativePkgDir\n\t) {\n\t\tif (resolve) {\n\t\t\ttry {\n\t\t\t\t// biome-ignore lint/nursery/noShadow: no need to use shadowed variable\n\t\t\t\tupdatePackageJsonFile(file, (json) => {\n\t\t\t\t\tassert(typeof json.repository === \"object\");\n\t\t\t\t\tif (relativePkgDir === undefined) {\n\t\t\t\t\t\tdelete json.repository.directory;\n\t\t\t\t\t} else {\n\t\t\t\t\t\tjson.repository.directory = relativePkgDir;\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t\tfixResult.resolved = true;\n\t\t\t} catch (error: unknown) {\n\t\t\t\tfixResult.resolved = false;\n\t\t\t\tfixResult.errorMessages.push(\n\t\t\t\t\t`${(error as Error).message}\\n${(error as Error).stack}`,\n\t\t\t\t);\n\t\t\t}\n\t\t\treturn fixResult;\n\t\t}\n\t\tfailResult.errorMessages.push(\n\t\t\t`repository.directory value is wrong. Expected '${relativePkgDir}', got '${json.repository.directory}'`,\n\t\t);\n\t\treturn failResult;\n\t}\n\n\treturn true;\n});\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PackageJsonSorted.d.ts","sourceRoot":"","sources":["../../src/policies/PackageJsonSorted.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"PackageJsonSorted.d.ts","sourceRoot":"","sources":["../../src/policies/PackageJsonSorted.ts"],"names":[],"mappings":"AAMA;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,oDA8C7B,CAAC"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { updatePackageJsonFile } from "@tylerbu/cli-api";
|
|
2
|
+
import { join } from "pathe";
|
|
2
3
|
import { sortPackageJson } from "sort-package-json";
|
|
3
4
|
import { definePackagePolicy } from "../policyDefiners/definePackagePolicy.js";
|
|
4
5
|
/**
|
|
@@ -6,7 +7,7 @@ import { definePackagePolicy } from "../policyDefiners/definePackagePolicy.js";
|
|
|
6
7
|
*
|
|
7
8
|
* @alpha
|
|
8
9
|
*/
|
|
9
|
-
export const PackageJsonSorted = definePackagePolicy("PackageJsonSorted", async (json, { file, resolve }) => {
|
|
10
|
+
export const PackageJsonSorted = definePackagePolicy("PackageJsonSorted", async (json, { file, root, resolve }) => {
|
|
10
11
|
const sortedJson = sortPackageJson(json);
|
|
11
12
|
const isSorted = JSON.stringify(sortedJson) === JSON.stringify(json);
|
|
12
13
|
if (isSorted) {
|
|
@@ -15,11 +16,14 @@ export const PackageJsonSorted = definePackagePolicy("PackageJsonSorted", async
|
|
|
15
16
|
if (resolve) {
|
|
16
17
|
try {
|
|
17
18
|
// biome-ignore lint/nursery/noShadow: no need to use the shadowed variable
|
|
18
|
-
await updatePackageJsonFile(file, (json) => json, {
|
|
19
|
+
await updatePackageJsonFile(join(root, file), (json) => json, {
|
|
20
|
+
sort: true,
|
|
21
|
+
});
|
|
19
22
|
const result = {
|
|
20
23
|
name: PackageJsonSorted.name,
|
|
21
24
|
file,
|
|
22
25
|
resolved: true,
|
|
26
|
+
errorMessages: [],
|
|
23
27
|
};
|
|
24
28
|
return result;
|
|
25
29
|
}
|
|
@@ -29,7 +33,10 @@ export const PackageJsonSorted = definePackagePolicy("PackageJsonSorted", async
|
|
|
29
33
|
file,
|
|
30
34
|
resolved: false,
|
|
31
35
|
autoFixable: true,
|
|
32
|
-
|
|
36
|
+
errorMessages: [
|
|
37
|
+
error.message,
|
|
38
|
+
error.stack ?? "",
|
|
39
|
+
],
|
|
33
40
|
};
|
|
34
41
|
return result;
|
|
35
42
|
}
|
|
@@ -39,6 +46,7 @@ export const PackageJsonSorted = definePackagePolicy("PackageJsonSorted", async
|
|
|
39
46
|
name: PackageJsonSorted.name,
|
|
40
47
|
file,
|
|
41
48
|
autoFixable: true,
|
|
49
|
+
errorMessages: [],
|
|
42
50
|
};
|
|
43
51
|
return result;
|
|
44
52
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PackageJsonSorted.js","sourceRoot":"","sources":["../../src/policies/PackageJsonSorted.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AAE/E;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,mBAAmB,CACnD,mBAAmB,EACnB,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE;
|
|
1
|
+
{"version":3,"file":"PackageJsonSorted.js","sourceRoot":"","sources":["../../src/policies/PackageJsonSorted.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAC7B,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AAE/E;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,mBAAmB,CACnD,mBAAmB,EACnB,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE;IACvC,MAAM,UAAU,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAErE,IAAI,QAAQ,EAAE,CAAC;QACd,OAAO,IAAI,CAAC;IACb,CAAC;IAED,IAAI,OAAO,EAAE,CAAC;QACb,IAAI,CAAC;YACJ,2EAA2E;YAC3E,MAAM,qBAAqB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE;gBAC7D,IAAI,EAAE,IAAI;aACV,CAAC,CAAC;YACH,MAAM,MAAM,GAAoB;gBAC/B,IAAI,EAAE,iBAAiB,CAAC,IAAI;gBAC5B,IAAI;gBACJ,QAAQ,EAAE,IAAI;gBACd,aAAa,EAAE,EAAE;aACjB,CAAC;YACF,OAAO,MAAM,CAAC;QACf,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACzB,MAAM,MAAM,GAAoB;gBAC/B,IAAI,EAAE,iBAAiB,CAAC,IAAI;gBAC5B,IAAI;gBACJ,QAAQ,EAAE,KAAK;gBACf,WAAW,EAAE,IAAI;gBACjB,aAAa,EAAE;oBACb,KAAe,CAAC,OAAO;oBACvB,KAAe,CAAC,KAAK,IAAI,EAAE;iBAC5B;aACD,CAAC;YACF,OAAO,MAAM,CAAC;QACf,CAAC;IACF,CAAC;SAAM,CAAC;QACP,MAAM,MAAM,GAAkB;YAC7B,IAAI,EAAE,iBAAiB,CAAC,IAAI;YAC5B,IAAI;YACJ,WAAW,EAAE,IAAI;YACjB,aAAa,EAAE,EAAE;SACjB,CAAC;QACF,OAAO,MAAM,CAAC;IACf,CAAC;AACF,CAAC,CACD,CAAC","sourcesContent":["import { updatePackageJsonFile } from \"@tylerbu/cli-api\";\nimport { join } from \"pathe\";\nimport { sortPackageJson } from \"sort-package-json\";\nimport type { PolicyFailure, PolicyFixResult } from \"../policy.js\";\nimport { definePackagePolicy } from \"../policyDefiners/definePackagePolicy.js\";\n\n/**\n * A repo policy that checks if package.json files in the repo are sorted using sort-package-json.\n *\n * @alpha\n */\nexport const PackageJsonSorted = definePackagePolicy(\n\t\"PackageJsonSorted\",\n\tasync (json, { file, root, resolve }) => {\n\t\tconst sortedJson = sortPackageJson(json);\n\t\tconst isSorted = JSON.stringify(sortedJson) === JSON.stringify(json);\n\n\t\tif (isSorted) {\n\t\t\treturn true;\n\t\t}\n\n\t\tif (resolve) {\n\t\t\ttry {\n\t\t\t\t// biome-ignore lint/nursery/noShadow: no need to use the shadowed variable\n\t\t\t\tawait updatePackageJsonFile(join(root, file), (json) => json, {\n\t\t\t\t\tsort: true,\n\t\t\t\t});\n\t\t\t\tconst result: PolicyFixResult = {\n\t\t\t\t\tname: PackageJsonSorted.name,\n\t\t\t\t\tfile,\n\t\t\t\t\tresolved: true,\n\t\t\t\t\terrorMessages: [],\n\t\t\t\t};\n\t\t\t\treturn result;\n\t\t\t} catch (error: unknown) {\n\t\t\t\tconst result: PolicyFixResult = {\n\t\t\t\t\tname: PackageJsonSorted.name,\n\t\t\t\t\tfile,\n\t\t\t\t\tresolved: false,\n\t\t\t\t\tautoFixable: true,\n\t\t\t\t\terrorMessages: [\n\t\t\t\t\t\t(error as Error).message,\n\t\t\t\t\t\t(error as Error).stack ?? \"\",\n\t\t\t\t\t],\n\t\t\t\t};\n\t\t\t\treturn result;\n\t\t\t}\n\t\t} else {\n\t\t\tconst result: PolicyFailure = {\n\t\t\t\tname: PackageJsonSorted.name,\n\t\t\t\tfile,\n\t\t\t\tautoFixable: true,\n\t\t\t\terrorMessages: [],\n\t\t\t};\n\t\t\treturn result;\n\t\t}\n\t},\n);\n"]}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Policy settings for the PackageLicense repo policy.
|
|
3
|
+
*
|
|
4
|
+
* @alpha
|
|
5
|
+
*/
|
|
6
|
+
export interface PackageLicenseSettings {
|
|
7
|
+
/**
|
|
8
|
+
* Whether to skip validation for private packages.
|
|
9
|
+
*
|
|
10
|
+
* @defaultValue true
|
|
11
|
+
*
|
|
12
|
+
* @remarks
|
|
13
|
+
*
|
|
14
|
+
* Private packages (those with `private: true` in package.json) are typically
|
|
15
|
+
* not published and may not need a LICENSE file. Set to `false` to require
|
|
16
|
+
* LICENSE files for all packages.
|
|
17
|
+
*/
|
|
18
|
+
skipPrivate?: boolean;
|
|
19
|
+
/**
|
|
20
|
+
* The name of the LICENSE file to look for and sync.
|
|
21
|
+
*
|
|
22
|
+
* @defaultValue "LICENSE"
|
|
23
|
+
*/
|
|
24
|
+
licenseFileName?: string;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* A repo policy that ensures each package has a LICENSE file that matches the root LICENSE.
|
|
28
|
+
*
|
|
29
|
+
* @remarks
|
|
30
|
+
*
|
|
31
|
+
* This policy is essential for monorepos where individual packages are published
|
|
32
|
+
* to npm. Each published package should include a LICENSE file, and it should
|
|
33
|
+
* match the root repository's LICENSE to ensure consistent licensing.
|
|
34
|
+
*
|
|
35
|
+
* The policy:
|
|
36
|
+
* 1. Checks if a LICENSE file exists in the package directory
|
|
37
|
+
* 2. Compares it with the root LICENSE file
|
|
38
|
+
* 3. Can auto-fix by copying the root LICENSE to the package directory
|
|
39
|
+
*
|
|
40
|
+
* By default, private packages are skipped since they're not published.
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```typescript
|
|
44
|
+
* import { makePolicy } from "repopo";
|
|
45
|
+
* import { PackageLicense } from "repopo/policies";
|
|
46
|
+
*
|
|
47
|
+
* const config: RepopoConfig = {
|
|
48
|
+
* policies: [
|
|
49
|
+
* // Use defaults (skip private, look for LICENSE)
|
|
50
|
+
* makePolicy(PackageLicense),
|
|
51
|
+
*
|
|
52
|
+
* // Or require LICENSE for all packages including private
|
|
53
|
+
* makePolicy(PackageLicense, { skipPrivate: false }),
|
|
54
|
+
* ],
|
|
55
|
+
* };
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @alpha
|
|
59
|
+
*/
|
|
60
|
+
export declare const PackageLicense: import("../policy.js").PolicyDefinition<PackageLicenseSettings | undefined>;
|
|
61
|
+
//# sourceMappingURL=PackageLicense.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PackageLicense.d.ts","sourceRoot":"","sources":["../../src/policies/PackageLicense.ts"],"names":[],"mappings":"AAOA;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACtC;;;;;;;;;;OAUG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CACzB;AA8CD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,eAAO,MAAM,cAAc,6EAoFzB,CAAC"}
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
import { existsSync } from "node:fs";
|
|
2
|
+
import { copyFile, readFile } from "node:fs/promises";
|
|
3
|
+
import path from "pathe";
|
|
4
|
+
import { definePackagePolicy } from "../policyDefiners/definePackagePolicy.js";
|
|
5
|
+
const DEFAULT_LICENSE_FILE_NAME = "LICENSE";
|
|
6
|
+
const POLICY_NAME = "PackageLicense";
|
|
7
|
+
/**
|
|
8
|
+
* Copies the root LICENSE file to the package directory.
|
|
9
|
+
* @returns A PolicyFixResult indicating success or failure.
|
|
10
|
+
*/
|
|
11
|
+
async function copyLicenseFile(rootLicensePath, packageLicensePath, policyName, file, packageName, licenseFileName, isCreate) {
|
|
12
|
+
try {
|
|
13
|
+
await copyFile(rootLicensePath, packageLicensePath);
|
|
14
|
+
return {
|
|
15
|
+
name: policyName,
|
|
16
|
+
file,
|
|
17
|
+
resolved: true,
|
|
18
|
+
autoFixable: true,
|
|
19
|
+
errorMessages: [
|
|
20
|
+
isCreate
|
|
21
|
+
? `Created ${licenseFileName} file for package "${packageName}"`
|
|
22
|
+
: `Updated ${licenseFileName} file for package "${packageName}" to match root`,
|
|
23
|
+
],
|
|
24
|
+
};
|
|
25
|
+
}
|
|
26
|
+
catch {
|
|
27
|
+
return {
|
|
28
|
+
name: policyName,
|
|
29
|
+
file,
|
|
30
|
+
resolved: false,
|
|
31
|
+
autoFixable: true,
|
|
32
|
+
errorMessages: [
|
|
33
|
+
isCreate
|
|
34
|
+
? `Failed to copy ${licenseFileName} to package "${packageName}"`
|
|
35
|
+
: `Failed to update ${licenseFileName} for package "${packageName}"`,
|
|
36
|
+
],
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* A repo policy that ensures each package has a LICENSE file that matches the root LICENSE.
|
|
42
|
+
*
|
|
43
|
+
* @remarks
|
|
44
|
+
*
|
|
45
|
+
* This policy is essential for monorepos where individual packages are published
|
|
46
|
+
* to npm. Each published package should include a LICENSE file, and it should
|
|
47
|
+
* match the root repository's LICENSE to ensure consistent licensing.
|
|
48
|
+
*
|
|
49
|
+
* The policy:
|
|
50
|
+
* 1. Checks if a LICENSE file exists in the package directory
|
|
51
|
+
* 2. Compares it with the root LICENSE file
|
|
52
|
+
* 3. Can auto-fix by copying the root LICENSE to the package directory
|
|
53
|
+
*
|
|
54
|
+
* By default, private packages are skipped since they're not published.
|
|
55
|
+
*
|
|
56
|
+
* @example
|
|
57
|
+
* ```typescript
|
|
58
|
+
* import { makePolicy } from "repopo";
|
|
59
|
+
* import { PackageLicense } from "repopo/policies";
|
|
60
|
+
*
|
|
61
|
+
* const config: RepopoConfig = {
|
|
62
|
+
* policies: [
|
|
63
|
+
* // Use defaults (skip private, look for LICENSE)
|
|
64
|
+
* makePolicy(PackageLicense),
|
|
65
|
+
*
|
|
66
|
+
* // Or require LICENSE for all packages including private
|
|
67
|
+
* makePolicy(PackageLicense, { skipPrivate: false }),
|
|
68
|
+
* ],
|
|
69
|
+
* };
|
|
70
|
+
* ```
|
|
71
|
+
*
|
|
72
|
+
* @alpha
|
|
73
|
+
*/
|
|
74
|
+
export const PackageLicense = definePackagePolicy("PackageLicense", async (json, { file, root, resolve, config }) => {
|
|
75
|
+
const skipPrivate = config?.skipPrivate ?? true;
|
|
76
|
+
const licenseFileName = config?.licenseFileName ?? DEFAULT_LICENSE_FILE_NAME;
|
|
77
|
+
// Skip private packages if configured to do so
|
|
78
|
+
if (skipPrivate && json.private === true) {
|
|
79
|
+
return true;
|
|
80
|
+
}
|
|
81
|
+
const packageName = json.name ?? "unknown";
|
|
82
|
+
// file is an absolute path, get the directory containing package.json
|
|
83
|
+
const packageDir = path.dirname(file);
|
|
84
|
+
const packageLicensePath = path.join(packageDir, licenseFileName);
|
|
85
|
+
const rootLicensePath = path.join(root, licenseFileName);
|
|
86
|
+
// Check if root LICENSE exists
|
|
87
|
+
if (!existsSync(rootLicensePath)) {
|
|
88
|
+
return {
|
|
89
|
+
name: POLICY_NAME,
|
|
90
|
+
file,
|
|
91
|
+
autoFixable: false,
|
|
92
|
+
errorMessages: [
|
|
93
|
+
`Cannot validate package LICENSE: root ${licenseFileName} file not found`,
|
|
94
|
+
],
|
|
95
|
+
};
|
|
96
|
+
}
|
|
97
|
+
// Check if package LICENSE exists
|
|
98
|
+
if (!existsSync(packageLicensePath)) {
|
|
99
|
+
if (resolve) {
|
|
100
|
+
return await copyLicenseFile(rootLicensePath, packageLicensePath, POLICY_NAME, file, packageName, licenseFileName, true);
|
|
101
|
+
}
|
|
102
|
+
return {
|
|
103
|
+
name: POLICY_NAME,
|
|
104
|
+
file,
|
|
105
|
+
autoFixable: true,
|
|
106
|
+
errorMessages: [
|
|
107
|
+
`${licenseFileName} file missing for package "${packageName}"`,
|
|
108
|
+
],
|
|
109
|
+
};
|
|
110
|
+
}
|
|
111
|
+
// Compare package LICENSE with root LICENSE
|
|
112
|
+
const [packageLicenseContent, rootLicenseContent] = await Promise.all([
|
|
113
|
+
readFile(packageLicensePath, "utf-8"),
|
|
114
|
+
readFile(rootLicensePath, "utf-8"),
|
|
115
|
+
]);
|
|
116
|
+
if (packageLicenseContent !== rootLicenseContent) {
|
|
117
|
+
if (resolve) {
|
|
118
|
+
return await copyLicenseFile(rootLicensePath, packageLicensePath, POLICY_NAME, file, packageName, licenseFileName, false);
|
|
119
|
+
}
|
|
120
|
+
return {
|
|
121
|
+
name: POLICY_NAME,
|
|
122
|
+
file,
|
|
123
|
+
autoFixable: true,
|
|
124
|
+
errorMessages: [
|
|
125
|
+
`${licenseFileName} file in package "${packageName}" doesn't match root ${licenseFileName}`,
|
|
126
|
+
],
|
|
127
|
+
};
|
|
128
|
+
}
|
|
129
|
+
return true;
|
|
130
|
+
});
|
|
131
|
+
//# sourceMappingURL=PackageLicense.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PackageLicense.js","sourceRoot":"","sources":["../../src/policies/PackageLicense.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,IAAI,MAAM,OAAO,CAAC;AAGzB,OAAO,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AA6B/E,MAAM,yBAAyB,GAAG,SAAS,CAAC;AAC5C,MAAM,WAAW,GAAG,gBAAgB,CAAC;AAErC;;;GAGG;AACH,KAAK,UAAU,eAAe,CAC7B,eAAuB,EACvB,kBAA0B,EAC1B,UAAkB,EAClB,IAAY,EACZ,WAAmB,EACnB,eAAuB,EACvB,QAAiB;IAEjB,IAAI,CAAC;QACJ,MAAM,QAAQ,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAAC;QACpD,OAAO;YACN,IAAI,EAAE,UAAU;YAChB,IAAI;YACJ,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,IAAI;YACjB,aAAa,EAAE;gBACd,QAAQ;oBACP,CAAC,CAAC,WAAW,eAAe,sBAAsB,WAAW,GAAG;oBAChE,CAAC,CAAC,WAAW,eAAe,sBAAsB,WAAW,iBAAiB;aAC/E;SACD,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACR,OAAO;YACN,IAAI,EAAE,UAAU;YAChB,IAAI;YACJ,QAAQ,EAAE,KAAK;YACf,WAAW,EAAE,IAAI;YACjB,aAAa,EAAE;gBACd,QAAQ;oBACP,CAAC,CAAC,kBAAkB,eAAe,gBAAgB,WAAW,GAAG;oBACjE,CAAC,CAAC,oBAAoB,eAAe,iBAAiB,WAAW,GAAG;aACrE;SACD,CAAC;IACH,CAAC;AACF,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,mBAAmB,CAG/C,gBAAgB,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE;IACnE,MAAM,WAAW,GAAG,MAAM,EAAE,WAAW,IAAI,IAAI,CAAC;IAChD,MAAM,eAAe,GAAG,MAAM,EAAE,eAAe,IAAI,yBAAyB,CAAC;IAE7E,+CAA+C;IAC/C,IAAI,WAAW,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC;IACb,CAAC;IAED,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,IAAI,SAAS,CAAC;IAC3C,sEAAsE;IACtE,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,MAAM,kBAAkB,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;IAClE,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IAEzD,+BAA+B;IAC/B,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC;QAClC,OAAO;YACN,IAAI,EAAE,WAAW;YACjB,IAAI;YACJ,WAAW,EAAE,KAAK;YAClB,aAAa,EAAE;gBACd,yCAAyC,eAAe,iBAAiB;aACzE;SACD,CAAC;IACH,CAAC;IAED,kCAAkC;IAClC,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACrC,IAAI,OAAO,EAAE,CAAC;YACb,OAAO,MAAM,eAAe,CAC3B,eAAe,EACf,kBAAkB,EAClB,WAAW,EACX,IAAI,EACJ,WAAW,EACX,eAAe,EACf,IAAI,CACJ,CAAC;QACH,CAAC;QAED,OAAO;YACN,IAAI,EAAE,WAAW;YACjB,IAAI;YACJ,WAAW,EAAE,IAAI;YACjB,aAAa,EAAE;gBACd,GAAG,eAAe,8BAA8B,WAAW,GAAG;aAC9D;SACD,CAAC;IACH,CAAC;IAED,4CAA4C;IAC5C,MAAM,CAAC,qBAAqB,EAAE,kBAAkB,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACrE,QAAQ,CAAC,kBAAkB,EAAE,OAAO,CAAC;QACrC,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;KAClC,CAAC,CAAC;IAEH,IAAI,qBAAqB,KAAK,kBAAkB,EAAE,CAAC;QAClD,IAAI,OAAO,EAAE,CAAC;YACb,OAAO,MAAM,eAAe,CAC3B,eAAe,EACf,kBAAkB,EAClB,WAAW,EACX,IAAI,EACJ,WAAW,EACX,eAAe,EACf,KAAK,CACL,CAAC;QACH,CAAC;QAED,OAAO;YACN,IAAI,EAAE,WAAW;YACjB,IAAI;YACJ,WAAW,EAAE,IAAI;YACjB,aAAa,EAAE;gBACd,GAAG,eAAe,qBAAqB,WAAW,wBAAwB,eAAe,EAAE;aAC3F;SACD,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACb,CAAC,CAAC,CAAC","sourcesContent":["import { existsSync } from \"node:fs\";\nimport { copyFile, readFile } from \"node:fs/promises\";\nimport path from \"pathe\";\nimport type { PackageJson } from \"type-fest\";\nimport type { PolicyFixResult } from \"../policy.js\";\nimport { definePackagePolicy } from \"../policyDefiners/definePackagePolicy.js\";\n\n/**\n * Policy settings for the PackageLicense repo policy.\n *\n * @alpha\n */\nexport interface PackageLicenseSettings {\n\t/**\n\t * Whether to skip validation for private packages.\n\t *\n\t * @defaultValue true\n\t *\n\t * @remarks\n\t *\n\t * Private packages (those with `private: true` in package.json) are typically\n\t * not published and may not need a LICENSE file. Set to `false` to require\n\t * LICENSE files for all packages.\n\t */\n\tskipPrivate?: boolean;\n\n\t/**\n\t * The name of the LICENSE file to look for and sync.\n\t *\n\t * @defaultValue \"LICENSE\"\n\t */\n\tlicenseFileName?: string;\n}\n\nconst DEFAULT_LICENSE_FILE_NAME = \"LICENSE\";\nconst POLICY_NAME = \"PackageLicense\";\n\n/**\n * Copies the root LICENSE file to the package directory.\n * @returns A PolicyFixResult indicating success or failure.\n */\nasync function copyLicenseFile(\n\trootLicensePath: string,\n\tpackageLicensePath: string,\n\tpolicyName: string,\n\tfile: string,\n\tpackageName: string,\n\tlicenseFileName: string,\n\tisCreate: boolean,\n): Promise<PolicyFixResult> {\n\ttry {\n\t\tawait copyFile(rootLicensePath, packageLicensePath);\n\t\treturn {\n\t\t\tname: policyName,\n\t\t\tfile,\n\t\t\tresolved: true,\n\t\t\tautoFixable: true,\n\t\t\terrorMessages: [\n\t\t\t\tisCreate\n\t\t\t\t\t? `Created ${licenseFileName} file for package \"${packageName}\"`\n\t\t\t\t\t: `Updated ${licenseFileName} file for package \"${packageName}\" to match root`,\n\t\t\t],\n\t\t};\n\t} catch {\n\t\treturn {\n\t\t\tname: policyName,\n\t\t\tfile,\n\t\t\tresolved: false,\n\t\t\tautoFixable: true,\n\t\t\terrorMessages: [\n\t\t\t\tisCreate\n\t\t\t\t\t? `Failed to copy ${licenseFileName} to package \"${packageName}\"`\n\t\t\t\t\t: `Failed to update ${licenseFileName} for package \"${packageName}\"`,\n\t\t\t],\n\t\t};\n\t}\n}\n\n/**\n * A repo policy that ensures each package has a LICENSE file that matches the root LICENSE.\n *\n * @remarks\n *\n * This policy is essential for monorepos where individual packages are published\n * to npm. Each published package should include a LICENSE file, and it should\n * match the root repository's LICENSE to ensure consistent licensing.\n *\n * The policy:\n * 1. Checks if a LICENSE file exists in the package directory\n * 2. Compares it with the root LICENSE file\n * 3. Can auto-fix by copying the root LICENSE to the package directory\n *\n * By default, private packages are skipped since they're not published.\n *\n * @example\n * ```typescript\n * import { makePolicy } from \"repopo\";\n * import { PackageLicense } from \"repopo/policies\";\n *\n * const config: RepopoConfig = {\n * policies: [\n * // Use defaults (skip private, look for LICENSE)\n * makePolicy(PackageLicense),\n *\n * // Or require LICENSE for all packages including private\n * makePolicy(PackageLicense, { skipPrivate: false }),\n * ],\n * };\n * ```\n *\n * @alpha\n */\nexport const PackageLicense = definePackagePolicy<\n\tPackageJson,\n\tPackageLicenseSettings | undefined\n>(\"PackageLicense\", async (json, { file, root, resolve, config }) => {\n\tconst skipPrivate = config?.skipPrivate ?? true;\n\tconst licenseFileName = config?.licenseFileName ?? DEFAULT_LICENSE_FILE_NAME;\n\n\t// Skip private packages if configured to do so\n\tif (skipPrivate && json.private === true) {\n\t\treturn true;\n\t}\n\n\tconst packageName = json.name ?? \"unknown\";\n\t// file is an absolute path, get the directory containing package.json\n\tconst packageDir = path.dirname(file);\n\tconst packageLicensePath = path.join(packageDir, licenseFileName);\n\tconst rootLicensePath = path.join(root, licenseFileName);\n\n\t// Check if root LICENSE exists\n\tif (!existsSync(rootLicensePath)) {\n\t\treturn {\n\t\t\tname: POLICY_NAME,\n\t\t\tfile,\n\t\t\tautoFixable: false,\n\t\t\terrorMessages: [\n\t\t\t\t`Cannot validate package LICENSE: root ${licenseFileName} file not found`,\n\t\t\t],\n\t\t};\n\t}\n\n\t// Check if package LICENSE exists\n\tif (!existsSync(packageLicensePath)) {\n\t\tif (resolve) {\n\t\t\treturn await copyLicenseFile(\n\t\t\t\trootLicensePath,\n\t\t\t\tpackageLicensePath,\n\t\t\t\tPOLICY_NAME,\n\t\t\t\tfile,\n\t\t\t\tpackageName,\n\t\t\t\tlicenseFileName,\n\t\t\t\ttrue,\n\t\t\t);\n\t\t}\n\n\t\treturn {\n\t\t\tname: POLICY_NAME,\n\t\t\tfile,\n\t\t\tautoFixable: true,\n\t\t\terrorMessages: [\n\t\t\t\t`${licenseFileName} file missing for package \"${packageName}\"`,\n\t\t\t],\n\t\t};\n\t}\n\n\t// Compare package LICENSE with root LICENSE\n\tconst [packageLicenseContent, rootLicenseContent] = await Promise.all([\n\t\treadFile(packageLicensePath, \"utf-8\"),\n\t\treadFile(rootLicensePath, \"utf-8\"),\n\t]);\n\n\tif (packageLicenseContent !== rootLicenseContent) {\n\t\tif (resolve) {\n\t\t\treturn await copyLicenseFile(\n\t\t\t\trootLicensePath,\n\t\t\t\tpackageLicensePath,\n\t\t\t\tPOLICY_NAME,\n\t\t\t\tfile,\n\t\t\t\tpackageName,\n\t\t\t\tlicenseFileName,\n\t\t\t\tfalse,\n\t\t\t);\n\t\t}\n\n\t\treturn {\n\t\t\tname: POLICY_NAME,\n\t\t\tfile,\n\t\t\tautoFixable: true,\n\t\t\terrorMessages: [\n\t\t\t\t`${licenseFileName} file in package \"${packageName}\" doesn't match root ${licenseFileName}`,\n\t\t\t],\n\t\t};\n\t}\n\n\treturn true;\n});\n"]}
|