@shivaedev/quality 0.61.1 → 0.62.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 +13 -0
- package/README.md +24 -4
- package/dist/adapters/agentLinkFindings.d.ts +7 -0
- package/dist/adapters/agentLinkFindings.d.ts.map +1 -0
- package/dist/adapters/agentLinkFindings.js +18 -0
- package/dist/adapters/agentLinkFindings.js.map +1 -0
- package/dist/adapters/asciiFindings.d.ts +10 -0
- package/dist/adapters/asciiFindings.d.ts.map +1 -0
- package/dist/adapters/asciiFindings.js +31 -0
- package/dist/adapters/asciiFindings.js.map +1 -0
- package/dist/adapters/catalogEntries.d.ts +14 -0
- package/dist/adapters/catalogEntries.d.ts.map +1 -0
- package/dist/adapters/catalogEntries.js +58 -0
- package/dist/adapters/catalogEntries.js.map +1 -0
- package/dist/adapters/catalogWorkspace.d.ts +7 -0
- package/dist/adapters/catalogWorkspace.d.ts.map +1 -0
- package/dist/adapters/catalogWorkspace.js +18 -0
- package/dist/adapters/catalogWorkspace.js.map +1 -0
- package/dist/adapters/repositoryPathFindings.d.ts +4 -0
- package/dist/adapters/repositoryPathFindings.d.ts.map +1 -0
- package/dist/adapters/repositoryPathFindings.js +60 -0
- package/dist/adapters/repositoryPathFindings.js.map +1 -0
- package/dist/adapters/serviceFolderFindings.d.ts +3 -0
- package/dist/adapters/serviceFolderFindings.d.ts.map +1 -0
- package/dist/adapters/serviceFolderFindings.js +65 -0
- package/dist/adapters/serviceFolderFindings.js.map +1 -0
- package/dist/inventory/walk.js +1 -1
- package/dist/inventory/walk.js.map +1 -1
- package/dist/rules/builtIn.d.ts +3 -1
- package/dist/rules/builtIn.d.ts.map +1 -1
- package/dist/rules/builtIn.js +10 -0
- package/dist/rules/builtIn.js.map +1 -1
- package/dist/rules/docs/agentLinks.d.ts +2 -0
- package/dist/rules/docs/agentLinks.d.ts.map +1 -0
- package/dist/rules/docs/agentLinks.js +8 -0
- package/dist/rules/docs/agentLinks.js.map +1 -0
- package/dist/rules/docs/repositoryPaths.d.ts +2 -0
- package/dist/rules/docs/repositoryPaths.d.ts.map +1 -0
- package/dist/rules/docs/repositoryPaths.js +8 -0
- package/dist/rules/docs/repositoryPaths.js.map +1 -0
- package/dist/rules/effect/serviceFolders.d.ts +2 -0
- package/dist/rules/effect/serviceFolders.d.ts.map +1 -0
- package/dist/rules/effect/serviceFolders.js +9 -0
- package/dist/rules/effect/serviceFolders.js.map +1 -0
- package/dist/rules/files/ascii.d.ts +4 -0
- package/dist/rules/files/ascii.d.ts.map +1 -0
- package/dist/rules/files/ascii.js +13 -0
- package/dist/rules/files/ascii.js.map +1 -0
- package/dist/rules/files/folderNames.d.ts.map +1 -1
- package/dist/rules/files/folderNames.js +7 -4
- package/dist/rules/files/folderNames.js.map +1 -1
- package/dist/rules/manifestsDependencyPins.d.ts +2 -0
- package/dist/rules/manifestsDependencyPins.d.ts.map +1 -0
- package/dist/rules/manifestsDependencyPins.js +50 -0
- package/dist/rules/manifestsDependencyPins.js.map +1 -0
- package/dist/testing/adapters/hookRepository.d.ts.map +1 -1
- package/dist/testing/adapters/hookRepository.js +1 -1
- package/dist/testing/adapters/hookRepository.js.map +1 -1
- package/package.json +3 -3
- package/src/adapters/agentLinkFindings.ts +23 -0
- package/src/adapters/asciiFindings.ts +39 -0
- package/src/adapters/catalogEntries.ts +81 -0
- package/src/adapters/catalogWorkspace.ts +19 -0
- package/src/adapters/repositoryPathFindings.ts +68 -0
- package/src/adapters/serviceFolderFindings.ts +75 -0
- package/src/inventory/walk.ts +1 -1
- package/src/rules/builtIn.ts +10 -0
- package/src/rules/docs/agentLinks.ts +8 -0
- package/src/rules/docs/repositoryPaths.ts +9 -0
- package/src/rules/effect/serviceFolders.ts +10 -0
- package/src/rules/files/ascii.ts +14 -0
- package/src/rules/files/folderNames.ts +7 -4
- package/src/rules/manifestsDependencyPins.ts +66 -0
- package/src/testing/adapters/hookRepository.ts +5 -1
package/src/rules/builtIn.ts
CHANGED
|
@@ -5,17 +5,21 @@ import { noJsdoc } from "#rules/comments/noJsdoc.ts";
|
|
|
5
5
|
import { noLineReference } from "#rules/comments/noLineReference.ts";
|
|
6
6
|
import { noPrReference } from "#rules/comments/noPrReference.ts";
|
|
7
7
|
import { noTodo } from "#rules/comments/noTodo.ts";
|
|
8
|
+
import { agentLinks } from "#rules/docs/agentLinks.ts";
|
|
8
9
|
import { docsReferences } from "#rules/docs/references.ts";
|
|
10
|
+
import { repositoryPaths } from "#rules/docs/repositoryPaths.ts";
|
|
9
11
|
import { docsUnversionedInstalls } from "#rules/docs/unversionedInstalls.ts";
|
|
10
12
|
import { adapterImports } from "#rules/effect/adapterImports.ts";
|
|
11
13
|
import { effectBoundary } from "#rules/effect/boundary.ts";
|
|
12
14
|
import { failureHonesty } from "#rules/effect/failureHonesty.ts";
|
|
13
15
|
import { rpcBoundary } from "#rules/effect/rpcBoundary.ts";
|
|
14
16
|
import { serviceDefinitionAssembly } from "#rules/effect/serviceDefinitionAssembly.ts";
|
|
17
|
+
import { serviceFolders } from "#rules/effect/serviceFolders.ts";
|
|
15
18
|
import { serviceIds } from "#rules/effect/serviceIds.ts";
|
|
16
19
|
import { serviceParameters } from "#rules/effect/serviceParameters.ts";
|
|
17
20
|
import { sharedErrorClasses } from "#rules/effect/sharedErrorClasses.ts";
|
|
18
21
|
import { sqlTransact } from "#rules/effect/sqlTransact.ts";
|
|
22
|
+
import { ascii } from "#rules/files/ascii.ts";
|
|
19
23
|
import { distinctCase } from "#rules/files/distinctCase.ts";
|
|
20
24
|
import { folderNames } from "#rules/files/folderNames.ts";
|
|
21
25
|
import { namedAfterExport } from "#rules/files/namedAfterExport.ts";
|
|
@@ -56,6 +60,7 @@ import { testsColocated } from "#rules/test-names/colocated.ts";
|
|
|
56
60
|
import { testsFollow } from "#rules/test-names/follow.ts";
|
|
57
61
|
import { biome } from "./biome.ts";
|
|
58
62
|
import { manifestsApplication } from "./manifestsApplication.ts";
|
|
63
|
+
import { manifestsDependencyPins } from "./manifestsDependencyPins.ts";
|
|
59
64
|
import { manifestsExportsShape } from "./manifestsExportsShape.ts";
|
|
60
65
|
import { manifestsSorted } from "./manifestsSorted.ts";
|
|
61
66
|
import { manifestsSourceFirst } from "./manifestsSourceFirst.ts";
|
|
@@ -66,6 +71,11 @@ import { noBarrel } from "./noBarrel.ts";
|
|
|
66
71
|
import { unusedCode } from "./unusedCode.ts";
|
|
67
72
|
|
|
68
73
|
export const builtInRules = [
|
|
74
|
+
agentLinks,
|
|
75
|
+
repositoryPaths,
|
|
76
|
+
serviceFolders,
|
|
77
|
+
ascii,
|
|
78
|
+
manifestsDependencyPins,
|
|
69
79
|
unusedCode,
|
|
70
80
|
adapterImports,
|
|
71
81
|
effectBoundary,
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { agentLinkFindings } from "#adapters/agentLinkFindings.ts";
|
|
2
|
+
import { defineRule } from "#rule.ts";
|
|
3
|
+
|
|
4
|
+
export const agentLinks = defineRule({
|
|
5
|
+
check: agentLinkFindings,
|
|
6
|
+
description: "Every CLAUDE.md is a symlink to the AGENTS.md file beside it.",
|
|
7
|
+
id: "docs/agent-links",
|
|
8
|
+
});
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { repositoryPathFindings } from "#adapters/repositoryPathFindings.ts";
|
|
2
|
+
import { defineRule } from "#rule.ts";
|
|
3
|
+
|
|
4
|
+
export const repositoryPaths = defineRule({
|
|
5
|
+
check: repositoryPathFindings,
|
|
6
|
+
description:
|
|
7
|
+
"Repository paths in Markdown backticks exist. Check explicit relative paths and paths beneath known repository folders; leave examples, globs, commands and URLs alone.",
|
|
8
|
+
id: "docs/repository-paths",
|
|
9
|
+
});
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { serviceFolderFindings } from "#adapters/serviceFolderFindings.ts";
|
|
2
|
+
import { defineRule } from "#rule.ts";
|
|
3
|
+
|
|
4
|
+
export const serviceFolders = defineRule({
|
|
5
|
+
check: serviceFolderFindings,
|
|
6
|
+
description:
|
|
7
|
+
"Each services/<name> folder has service.ts, and its service.ts exports one named const initialized by defineService. The service-definition-assembly rule checks its operation inventory.",
|
|
8
|
+
id: "effect/service-folders",
|
|
9
|
+
registrable: false,
|
|
10
|
+
});
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { Effect, Schema } from "effect";
|
|
2
|
+
import { asciiFindings } from "#adapters/asciiFindings.ts";
|
|
3
|
+
import { defineRule } from "#rule.ts";
|
|
4
|
+
|
|
5
|
+
const AsciiOptions = Schema.Struct({
|
|
6
|
+
files: Schema.Array(Schema.NonEmptyString).pipe(Schema.withDecodingDefaultKey(Effect.succeed([]))),
|
|
7
|
+
});
|
|
8
|
+
|
|
9
|
+
export const ascii = defineRule({
|
|
10
|
+
check: asciiFindings,
|
|
11
|
+
description: "Chosen text files contain only ASCII characters. No files are selected by default.",
|
|
12
|
+
id: "files/ascii",
|
|
13
|
+
options: Schema.toStandardSchemaV1(AsciiOptions, { parseOptions: { errors: "all", onExcessProperty: "error" } }),
|
|
14
|
+
});
|
|
@@ -36,9 +36,12 @@ function isModule(folder: string, stems: ReadonlySet<string>): boolean {
|
|
|
36
36
|
return stems.has(`${folder}/${name}`) || stems.has(`${posix.dirname(folder)}/${name}`);
|
|
37
37
|
}
|
|
38
38
|
|
|
39
|
-
function packageMessage(
|
|
39
|
+
function packageMessage(folder: string, packageName: string): string | undefined {
|
|
40
40
|
const expected = packageName.replace(/^@[^/]+\//u, "");
|
|
41
|
-
|
|
41
|
+
const nested = folder.split("/").slice(1).join("-");
|
|
42
|
+
return posix.basename(folder) === expected || nested === expected
|
|
43
|
+
? undefined
|
|
44
|
+
: `The folder of the package ${packageName} must be named "${expected}", in kebab-case after the package name, or its path below the workspace package root must join with "-" to "${expected}".`;
|
|
42
45
|
}
|
|
43
46
|
|
|
44
47
|
function groupMessage(name: string): string | undefined {
|
|
@@ -65,7 +68,7 @@ function messageFor(folder: string, context: Context): string | undefined {
|
|
|
65
68
|
}
|
|
66
69
|
const packageName = context.names.get(folder);
|
|
67
70
|
if (packageName !== undefined) {
|
|
68
|
-
return packageMessage(
|
|
71
|
+
return packageMessage(folder, packageName);
|
|
69
72
|
}
|
|
70
73
|
if (context.content.ignores(`${folder}/`)) {
|
|
71
74
|
return SNAKE.test(name) ? undefined : `"${name}" holds content, so it is named in snake_case, such as forest_path/.`;
|
|
@@ -91,7 +94,7 @@ export const folderNames = defineRule({
|
|
|
91
94
|
});
|
|
92
95
|
}),
|
|
93
96
|
description:
|
|
94
|
-
"A package folder
|
|
97
|
+
"A package folder's final name or its path below the workspace package root joined with hyphens matches its unscoped package name. A module folder is named after its main file, a content folder in snake_case and every other folder in kebab-case. TanStack Router configuration owns route folder names.",
|
|
95
98
|
id: "files/folder-names",
|
|
96
99
|
options: Schema.toStandardSchemaV1(FolderNamesOptions, { parseOptions: { errors: "all", onExcessProperty: "error" } }),
|
|
97
100
|
validate: validateGlobs,
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import { Effect } from "effect";
|
|
2
|
+
import { catalogEntries } from "#adapters/catalogEntries.ts";
|
|
3
|
+
import { catalogWorkspace } from "#adapters/catalogWorkspace.ts";
|
|
4
|
+
import { manifestFiles, readPackageManifest } from "#adapters/manifestInventory.ts";
|
|
5
|
+
import { defineRule, type Finding } from "#rule.ts";
|
|
6
|
+
|
|
7
|
+
const SECTIONS = ["dependencies", "devDependencies", "optionalDependencies", "peerDependencies"] as const;
|
|
8
|
+
const EXACT =
|
|
9
|
+
/^(?:npm:(?:@[^/\s]+\/)?[^@\s]+@)?(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)(?:-[\dA-Za-z-]+(?:\.[\dA-Za-z-]+)*)?(?:\+[\dA-Za-z-]+(?:\.[\dA-Za-z-]+)*)?$/u;
|
|
10
|
+
const LOCAL = /^(?:workspace:|file:|link:)/u;
|
|
11
|
+
|
|
12
|
+
function dependencyFinding(
|
|
13
|
+
file: string,
|
|
14
|
+
section: string,
|
|
15
|
+
name: string,
|
|
16
|
+
version: string,
|
|
17
|
+
catalogs: ReturnType<typeof catalogEntries>,
|
|
18
|
+
): readonly Finding[] {
|
|
19
|
+
if (LOCAL.test(version)) {
|
|
20
|
+
return [];
|
|
21
|
+
}
|
|
22
|
+
const catalog = version.startsWith("catalog:") ? version.slice("catalog:".length) : undefined;
|
|
23
|
+
const valid =
|
|
24
|
+
catalog === undefined
|
|
25
|
+
? !catalogs.present && EXACT.test(version)
|
|
26
|
+
: catalogs.entries.some((entry) => entry.catalog === catalog && entry.name === name);
|
|
27
|
+
return valid
|
|
28
|
+
? []
|
|
29
|
+
: [
|
|
30
|
+
{
|
|
31
|
+
file,
|
|
32
|
+
message: `${section} entry "${name}: ${version}" must ${catalogs.present || catalog !== undefined ? 'use "catalog:" (or a named catalog) with an entry for this dependency in pnpm-workspace.yaml' : "pin an exact version, including for npm aliases"}. Workspace, file and link dependencies stay local.`,
|
|
33
|
+
subject: `${section}.${name}`,
|
|
34
|
+
},
|
|
35
|
+
];
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
export const manifestsDependencyPins = defineRule({
|
|
39
|
+
check: (inputs) =>
|
|
40
|
+
Effect.gen(function* () {
|
|
41
|
+
const workspace = yield* catalogWorkspace(inputs);
|
|
42
|
+
const catalogs = catalogEntries(workspace.text);
|
|
43
|
+
const findings: Finding[] = catalogs.findings.map((finding) => ({ ...finding, file: workspace.file }));
|
|
44
|
+
for (const entry of catalogs.entries) {
|
|
45
|
+
if (!EXACT.test(entry.version)) {
|
|
46
|
+
findings.push({
|
|
47
|
+
file: workspace.file,
|
|
48
|
+
line: entry.line,
|
|
49
|
+
message: `Catalog entry "${entry.name}: ${entry.version}" is not an exact version. Pin one version, including for npm aliases.`,
|
|
50
|
+
});
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
for (const file of manifestFiles(inputs)) {
|
|
54
|
+
const manifest = yield* Effect.promise(() => readPackageManifest(inputs.readText, file));
|
|
55
|
+
findings.push(
|
|
56
|
+
...SECTIONS.flatMap((section) =>
|
|
57
|
+
Object.entries(manifest?.[section] ?? {}).flatMap(([name, version]) => dependencyFinding(file, section, name, version, catalogs)),
|
|
58
|
+
),
|
|
59
|
+
);
|
|
60
|
+
}
|
|
61
|
+
return findings;
|
|
62
|
+
}),
|
|
63
|
+
description:
|
|
64
|
+
"Pin external dependencies to exact versions; use catalog references when pnpm-workspace.yaml declares catalogs, and pin their entries too.",
|
|
65
|
+
id: "manifests/dependency-pins",
|
|
66
|
+
});
|
|
@@ -103,7 +103,11 @@ export function withScripts(root: string, scripts: Readonly<Record<string, strin
|
|
|
103
103
|
|
|
104
104
|
export function withQualityAt(repository: HookRepository, path: string): string {
|
|
105
105
|
writes(repository.root, path, 'import "@shivaedev/quality/cli.ts";\n');
|
|
106
|
-
writes(
|
|
106
|
+
writes(
|
|
107
|
+
repository.root,
|
|
108
|
+
"package.json",
|
|
109
|
+
manifest({ bin: { quality: `./${path}` }, devDependencies: { "@shivaedev/quality": "file:./node_modules/@shivaedev/quality" } }),
|
|
110
|
+
);
|
|
107
111
|
formatTree(repository.root);
|
|
108
112
|
return join(repository.root, path);
|
|
109
113
|
}
|