paperlint 2.1.0 → 3.0.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/CLAUDE.md +6 -1
- package/README.md +233 -224
- package/action.yml +4 -6
- package/dist/adapters/references/index.d.ts +13 -0
- package/dist/adapters/references/index.d.ts.map +1 -0
- package/dist/adapters/references/index.js +55 -0
- package/dist/adapters/references/index.js.map +1 -0
- package/dist/adapters/references/reach.io.d.ts +3 -0
- package/dist/adapters/references/reach.io.d.ts.map +1 -0
- package/dist/adapters/references/reach.io.js +14 -0
- package/dist/adapters/references/reach.io.js.map +1 -0
- package/dist/build.d.ts +15 -0
- package/dist/build.d.ts.map +1 -1
- package/dist/build.js +38 -4
- package/dist/build.js.map +1 -1
- package/dist/cli.d.ts +28 -25
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +277 -265
- package/dist/cli.js.map +1 -1
- package/dist/doctor.d.ts.map +1 -1
- package/dist/doctor.js +40 -72
- package/dist/doctor.js.map +1 -1
- package/dist/facts-file.d.ts +2 -2
- package/dist/facts-file.js +2 -2
- package/dist/hooks-settings.d.ts +0 -21
- package/dist/hooks-settings.d.ts.map +1 -1
- package/dist/hooks-settings.js +17 -135
- package/dist/hooks-settings.js.map +1 -1
- package/dist/init.d.ts +39 -29
- package/dist/init.d.ts.map +1 -1
- package/dist/init.js +143 -172
- package/dist/init.js.map +1 -1
- package/dist/link-skills.d.ts +1 -1
- package/dist/link-skills.d.ts.map +1 -1
- package/dist/link-skills.js +11 -29
- package/dist/link-skills.js.map +1 -1
- package/dist/new-paper.d.ts.map +1 -1
- package/dist/new-paper.js +2 -13
- package/dist/new-paper.js.map +1 -1
- package/dist/paper-files.d.ts +63 -0
- package/dist/paper-files.d.ts.map +1 -0
- package/dist/paper-files.js +69 -0
- package/dist/paper-files.js.map +1 -0
- package/dist/paper-settings.d.ts +13 -41
- package/dist/paper-settings.d.ts.map +1 -1
- package/dist/paper-settings.js +71 -71
- package/dist/paper-settings.js.map +1 -1
- package/dist/ports/check-references.d.ts +31 -0
- package/dist/ports/check-references.d.ts.map +1 -0
- package/dist/ports/check-references.js +7 -0
- package/dist/ports/check-references.js.map +1 -0
- package/dist/presets.d.ts +1 -1
- package/dist/presets.d.ts.map +1 -1
- package/dist/presets.js +4 -6
- package/dist/presets.js.map +1 -1
- package/dist/reference-rules.d.ts +47 -0
- package/dist/reference-rules.d.ts.map +1 -0
- package/dist/reference-rules.js +156 -0
- package/dist/reference-rules.js.map +1 -0
- package/dist/references.d.ts +36 -0
- package/dist/references.d.ts.map +1 -0
- package/dist/references.js +91 -0
- package/dist/references.js.map +1 -0
- package/dist/rules-config.d.ts +5 -3
- package/dist/rules-config.d.ts.map +1 -1
- package/dist/rules-config.js +15 -6
- package/dist/rules-config.js.map +1 -1
- package/dist/structure.js +3 -3
- package/dist/structure.js.map +1 -1
- package/dist/tex-requirements.js +2 -2
- package/dist/tex-requirements.js.map +1 -1
- package/dist/types.d.ts +20 -18
- package/dist/types.d.ts.map +1 -1
- package/dist/venue-rules.d.ts.map +1 -1
- package/dist/venue-rules.js +11 -9
- package/dist/venue-rules.js.map +1 -1
- package/docs/configuration.md +119 -104
- package/docs/e2e.md +1 -1
- package/docs/install.md +25 -40
- package/docs/optional-rules.md +5 -4
- package/docs/rules.md +60 -23
- package/eslint-rules/bib-reachable-entry.mjs +75 -0
- package/eslint-rules/latex-language.mjs +29 -1
- package/eslint-rules/paper-stages.harness.mjs +1 -117
- package/eslint-rules/paper-stages.mjs +0 -120
- package/eslint-rules/paper-stages.mutations.mjs +0 -76
- package/eslint-rules/paper-typography.mjs +267 -192
- package/eslint-rules/paper-typography.test.mjs +297 -0
- package/eslint-rules/papers.harness.mjs +8 -12
- package/eslint-rules/papers.mjs +17 -31
- package/eslint-rules/pdf-last-page-balance.mjs +4 -7
- package/eslint-rules/review-frontmatter.mjs +118 -0
- package/eslint-rules/review-frontmatter.schema.json +36 -0
- package/eslint-rules/review-frontmatter.test.mjs +118 -0
- package/eslint-rules/sibling-frontmatter.mjs +19 -0
- package/eslint-rules/sibling-frontmatter.schema.json +14 -0
- package/eslint.config.mjs +0 -15
- package/fixtures/real-markdown-paper/baseline.json +6 -7
- package/hooks/hooks.harness.mjs +39 -98
- package/hooks/hooks.mutations.mjs +6 -6
- package/hooks/paper-edit-guard.hook.d.mts +2 -3
- package/hooks/paper-edit-guard.hook.mjs +31 -42
- package/hooks/paper-skills-nudge.hook.mjs +21 -19
- package/hooks/paper-status-gates.hook.mjs +21 -19
- package/hooks/paper-status-gates.sh +8 -13
- package/lib/paper-config.d.mts +15 -25
- package/lib/paper-config.harness.mjs +18 -35
- package/lib/paper-config.mjs +83 -105
- package/lib/paper-config.mutations.mjs +2 -2
- package/lib/skill-checks.mjs +1 -1
- package/lib/skill-trigger-cases.harness.mjs +9 -8
- package/lib/skill-trigger-cases.mjs +7 -15
- package/package.json +1 -1
- package/scripts/eslint-report-guard.mjs +1 -1
- package/scripts/harness-api.frozen.json +0 -3
- package/scripts/mutation-batteries.frozen.json +4 -13
- package/skills/analyze-sibling-paper/SKILL.md +16 -12
- package/skills/analyze-sibling-paper/SKILL.md.spec.ts +15 -11
- package/skills/cold-read-diff/SKILL.md +20 -1
- package/skills/cold-read-diff/SKILL.md.spec.ts +19 -0
- package/skills/grade-paper-writing/SKILL.md +20 -1
- package/skills/grade-paper-writing/SKILL.md.spec.ts +19 -0
- package/skills/paper-pipeline/scripts/consumer.d.mts +0 -1
- package/skills/paper-pipeline/scripts/consumer.harness.mjs +8 -12
- package/skills/paper-pipeline/scripts/consumer.mjs +19 -33
- package/skills/paper-pipeline/scripts/extract-ref-facts.harness.mjs +6 -4
- package/skills/paper-pipeline/scripts/run-mechanical.mjs +2 -11
- package/skills/plan-paper-timeline/SKILL.md +2 -2
- package/skills/plan-paper-timeline/SKILL.md.spec.ts +1 -1
- package/skills/plan-paper-timeline/plan-paper-timeline.effects.harness.mjs +1 -1
- package/skills/plan-paper-timeline/plan-paper-timeline.effects.mutations.mjs +2 -2
- package/skills/render-paper/check-render.sh +2 -3
- package/skills/render-paper/render-paper.harness.mjs +2 -2
- package/skills/verify-citations/SKILL.md +10 -1
- package/skills/verify-citations/SKILL.md.spec.ts +9 -0
- package/skills/verify-citations/scripts/bib-authors.mjs +48 -26
- package/src/adapters/references/index.ts +102 -0
- package/src/adapters/references/reach.io.ts +12 -0
- package/src/build.harness.mjs +8 -4
- package/src/build.ts +62 -6
- package/src/cli.harness.mjs +147 -292
- package/src/cli.mutations.mjs +35 -44
- package/src/cli.ts +344 -304
- package/src/doctor.harness.mjs +41 -84
- package/src/doctor.mutations.mjs +9 -9
- package/src/doctor.ts +44 -89
- package/src/facts-file.test.ts +0 -7
- package/src/facts-file.ts +2 -2
- package/src/hooks-settings.harness.mjs +7 -92
- package/src/hooks-settings.mutations.mjs +2 -17
- package/src/hooks-settings.ts +18 -162
- package/src/init.test.ts +206 -0
- package/src/init.ts +186 -230
- package/src/link-skills.harness.mjs +1 -38
- package/src/link-skills.mutations.mjs +9 -5
- package/src/link-skills.ts +10 -34
- package/src/lint-fix.test.ts +120 -0
- package/src/new-paper.test.ts +1 -13
- package/src/new-paper.ts +2 -17
- package/src/paper-files.test.ts +290 -0
- package/src/paper-files.ts +144 -0
- package/src/paper-settings-commands.test.ts +84 -121
- package/src/paper-settings.test.ts +93 -64
- package/src/paper-settings.ts +99 -97
- package/src/ports/check-references.ts +28 -0
- package/src/presets.ts +5 -15
- package/src/reference-rules.ts +229 -0
- package/src/references.test.ts +209 -0
- package/src/references.ts +138 -0
- package/src/rules-config.harness.mjs +24 -8
- package/src/rules-config.ts +19 -7
- package/src/structure.harness.mjs +3 -1
- package/src/structure.ts +3 -3
- package/src/tex-requirements.ts +2 -2
- package/src/types.ts +30 -18
- package/src/venue-rules.test.ts +20 -11
- package/src/venue-rules.ts +11 -13
- package/eslint-rules/doc-fields.harness.mjs +0 -336
- package/eslint-rules/doc-fields.mjs +0 -186
- package/eslint-rules/doc-fields.mutations.mjs +0 -96
- package/eslint-rules/paper-typography.harness.mjs +0 -291
- package/eslint-rules/paper-typography.mutations.mjs +0 -131
- package/eslint-rules/review-findings-cause.harness.mjs +0 -228
- package/eslint-rules/review-findings-cause.mjs +0 -135
- package/eslint-rules/review-findings-cause.mutations.mjs +0 -72
- package/fixtures/paper-stages/authors-ran/PIPELINE-STATUS.md +0 -16
- package/fixtures/paper-stages/marker-in-prose/PIPELINE-STATUS.md +0 -17
- package/fixtures/review-findings-cause/clean.md +0 -17
- package/fixtures/review-findings-cause/defect.md +0 -14
- package/fixtures/review-findings-cause/old-debt.md +0 -14
- package/fixtures/review-findings-cause/quiet-in-fence.md +0 -16
package/dist/link-skills.js
CHANGED
|
@@ -27,12 +27,12 @@
|
|
|
27
27
|
* elsewhere, a dangling link — is someone else's, and is reported, not replaced.
|
|
28
28
|
*/
|
|
29
29
|
/* eslint-disable boundaries/dependencies -- legacy I/O, moves behind a port in #76 */
|
|
30
|
-
import { existsSync, lstatSync, mkdirSync, readlinkSync, realpathSync, symlinkSync,
|
|
30
|
+
import { existsSync, lstatSync, mkdirSync, readlinkSync, realpathSync, symlinkSync, } from "node:fs";
|
|
31
31
|
/* eslint-enable boundaries/dependencies */
|
|
32
32
|
import { createRequire } from "node:module";
|
|
33
|
-
import { dirname, join, relative, resolve
|
|
33
|
+
import { dirname, join, relative, resolve } from "node:path";
|
|
34
34
|
import { pathToFileURL } from "node:url";
|
|
35
|
-
import { installedSkills,
|
|
35
|
+
import { installedSkills, PACKAGE_NAME, SHIPPED_SKILLS_DIR, } from "../skills/paper-pipeline/scripts/consumer.mjs";
|
|
36
36
|
export { PACKAGE_NAME };
|
|
37
37
|
/** Where Claude Code looks for project skills, relative to the project root. */
|
|
38
38
|
export const SKILLS_HOME = join(".claude", "skills");
|
|
@@ -87,12 +87,8 @@ export function shippedSkills(pkgDir) {
|
|
|
87
87
|
return { error: e.message };
|
|
88
88
|
}
|
|
89
89
|
}
|
|
90
|
-
/**
|
|
91
|
-
|
|
92
|
-
* an install under the package's old name wrote it (`legacyTarget`) is `stale`: ours, from before
|
|
93
|
-
* the rename, and replaced on the next `init`.
|
|
94
|
-
*/
|
|
95
|
-
function inspect(entry, want, legacyTarget) {
|
|
90
|
+
/** What occupies `entry`, judged against the directory it should lead to. */
|
|
91
|
+
function inspect(entry, want) {
|
|
96
92
|
let st;
|
|
97
93
|
try {
|
|
98
94
|
st = lstatSync(entry);
|
|
@@ -100,11 +96,6 @@ function inspect(entry, want, legacyTarget) {
|
|
|
100
96
|
catch {
|
|
101
97
|
return { status: "missing" };
|
|
102
98
|
}
|
|
103
|
-
if (st.isSymbolicLink() && readlinkSync(entry) === legacyTarget)
|
|
104
|
-
return {
|
|
105
|
-
status: "stale",
|
|
106
|
-
reason: `a link into ${LEGACY_PACKAGE_NAME}, the package's old name — \`npx ${PACKAGE_NAME} init\` replaces it`,
|
|
107
|
-
};
|
|
108
99
|
try {
|
|
109
100
|
if (realpathSync(entry) === want)
|
|
110
101
|
return { status: "present" };
|
|
@@ -124,25 +115,16 @@ function inspect(entry, want, legacyTarget) {
|
|
|
124
115
|
reason: st.isDirectory() ? "a directory" : "a file",
|
|
125
116
|
};
|
|
126
117
|
}
|
|
127
|
-
/**
|
|
128
|
-
* One skill: inspect its entry and, when writing, create the link — or replace one an install
|
|
129
|
-
* under the package's old name made.
|
|
130
|
-
*/
|
|
118
|
+
/** One skill: inspect its entry and, when writing, create the link. */
|
|
131
119
|
function linkOne(name, { entry, target, want, write, }) {
|
|
132
|
-
const
|
|
133
|
-
|
|
134
|
-
const fixable = seen.status === "missing" || seen.status === "stale";
|
|
135
|
-
if (!write || !fixable) {
|
|
136
|
-
const status = seen.status === "stale" ? "foreign" : seen.status;
|
|
120
|
+
const seen = inspect(entry, want);
|
|
121
|
+
if (!write || seen.status !== "missing")
|
|
137
122
|
return seen.reason
|
|
138
|
-
? { name, status, reason: seen.reason }
|
|
139
|
-
: { name, status };
|
|
140
|
-
}
|
|
123
|
+
? { name, status: seen.status, reason: seen.reason }
|
|
124
|
+
: { name, status: seen.status };
|
|
141
125
|
try {
|
|
142
|
-
if (seen.status === "stale")
|
|
143
|
-
unlinkSync(entry);
|
|
144
126
|
symlinkSync(target, entry, "dir");
|
|
145
|
-
return { name, status:
|
|
127
|
+
return { name, status: "created" };
|
|
146
128
|
}
|
|
147
129
|
catch (e) {
|
|
148
130
|
return {
|
package/dist/link-skills.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"link-skills.js","sourceRoot":"","sources":["../src/link-skills.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,sFAAsF;AACtF,OAAO,EACL,UAAU,EACV,SAAS,EACT,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,WAAW,
|
|
1
|
+
{"version":3,"file":"link-skills.js","sourceRoot":"","sources":["../src/link-skills.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,sFAAsF;AACtF,OAAO,EACL,UAAU,EACV,SAAS,EACT,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,WAAW,GACZ,MAAM,SAAS,CAAC;AACjB,2CAA2C;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EACL,eAAe,EACf,YAAY,EACZ,kBAAkB,GACnB,MAAM,+CAA+C,CAAC;AAEvD,OAAO,EAAE,YAAY,EAAE,CAAC;AACxB,gFAAgF;AAChF,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;AAMrD;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,OAAe;IAC3C,IAAI,QAAgB,CAAC;IACrB,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,aAAa,CACvB,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,yBAAyB,CAAC,CAAC,CAAC,IAAI,CAC7D,CAAC;QACF,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,YAAY,eAAe,CAAC,CAAC;IACzD,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO;YACL,KAAK,EAAE,GAAI,CAA2B,CAAC,IAAI,IAAI,OAAO,KAAM,CAAW,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;SACjG,CAAC;IACJ,CAAC;IACD,MAAM,GAAG,GAAG,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC5C,+FAA+F;IAC/F,sCAAsC;IACtC,KAAK,IAAI,CAAC,GAAG,YAAY,CAAC,OAAO,CAAC,GAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QACrD,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,EAAE,cAAc,EAAE,YAAY,CAAC,CAAC;QACxD,IAAI,CAAC;YACH,IAAI,YAAY,CAAC,SAAS,CAAC,KAAK,GAAG;gBAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;QAC1E,CAAC;QAAC,MAAM,CAAC;YACP,0BAA0B;QAC5B,CAAC;QACD,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;YAAE,MAAM;IAC9B,CAAC;IACD,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;AAC/B,CAAC;AAED,gFAAgF;AAChF,MAAM,UAAU,aAAa,CAC3B,MAAc;IAId,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IACnD,8FAA8F;IAC9F,aAAa;IACb,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;QACxB,OAAO,EAAE,KAAK,EAAE,8CAA8C,SAAS,EAAE,EAAE,CAAC;IAC9E,mGAAmG;IACnG,0FAA0F;IAC1F,IAAI,CAAC;QACH,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,eAAe,CAAC,SAAS,CAAC,EAAE,CAAC;IAC1D,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,EAAE,KAAK,EAAG,CAAW,CAAC,OAAO,EAAE,CAAC;IACzC,CAAC;AACH,CAAC;AAqBD,6EAA6E;AAC7E,SAAS,OAAO,CACd,KAAa,EACb,IAAY;IAEZ,IAAI,EAAE,CAAC;IACP,IAAI,CAAC;QACH,EAAE,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IAC/B,CAAC;IACD,IAAI,CAAC;QACH,IAAI,YAAY,CAAC,KAAK,CAAC,KAAK,IAAI;YAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IACjE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC,cAAc,EAAE;YACxB,CAAC,CAAC;gBACE,MAAM,EAAE,SAAS;gBACjB,MAAM,EAAE,sBAAsB,YAAY,CAAC,KAAK,CAAC,EAAE;aACpD;YACH,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,kCAAkC,EAAE,CAAC;IACxE,CAAC;IACD,IAAI,EAAE,CAAC,cAAc,EAAE;QACrB,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,aAAa,YAAY,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;IAC3E,OAAO;QACL,MAAM,EAAE,SAAS;QACjB,MAAM,EAAE,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,QAAQ;KACpD,CAAC;AACJ,CAAC;AAED,uEAAuE;AACvE,SAAS,OAAO,CACd,IAAY,EACZ,EACE,KAAK,EACL,MAAM,EACN,IAAI,EACJ,KAAK,GAC2D;IAElE,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAClC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS;QACrC,OAAO,IAAI,CAAC,MAAM;YAChB,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE;YACpD,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;IACpC,IAAI,CAAC;QACH,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAClC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IACrC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO;YACL,IAAI;YACJ,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,8BAA+B,CAAW,CAAC,OAAO,EAAE;SAC7D,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CACxB,OAAe,EACf,EACE,KAAK,GAAG,IAAI,EACZ,MAAM,GAAG,aAAa,MACkC,EAAE;IAE5D,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAC5B,IAAI,OAAO,IAAI,GAAG;QAChB,OAAO;YACL,EAAE,EAAE,KAAK;YACT,KAAK,EAAE,GAAG,YAAY,0BAA0B,OAAO,KAAK,GAAG,CAAC,KAAK,GAAG;SACzE,CAAC;IACJ,MAAM,OAAO,GAAG,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACvC,IAAI,OAAO,IAAI,OAAO;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;IACnE,4FAA4F;IAC5F,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;IAE9E,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IACxC,IAAI,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtC,IAAI,CAAC;YACH,SAAS,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACvC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO;gBACL,EAAE,EAAE,KAAK;gBACT,KAAK,EAAE,iBAAiB,IAAI,KAAM,CAAW,CAAC,OAAO,EAAE;aACxD,CAAC;QACJ,CAAC;IACH,CAAC;IACD,4FAA4F;IAC5F,kEAAkE;IAClE,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3E,IAAI,OAAO,GAAkB,IAAI,CAAC;IAClC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAa,EAAE;QAClD,MAAM,MAAM,GAAG,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,CAAC;QACjE,OAAO,KAAK,MAAM,CAAC;QACnB,OAAO,OAAO,CAAC,IAAI,EAAE;YACnB,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC;YACvB,MAAM;YACN,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YACjD,KAAK;SACN,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AAC5C,CAAC"}
|
package/dist/new-paper.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"new-paper.d.ts","sourceRoot":"","sources":["../src/new-paper.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"new-paper.d.ts","sourceRoot":"","sources":["../src/new-paper.ts"],"names":[],"mappings":"AA6BA,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,IAAI,CAAC;AACvC,eAAO,MAAM,OAAO,EAAE,SAAS,WAAW,EAAkB,CAAC;AAC7D,eAAO,MAAM,cAAc,EAAE,WAAmB,CAAC;AAEjD,8FAA8F;AAC9F,eAAO,MAAM,iBAAiB,QAE7B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,cAAc,CAAC;AAExC,eAAO,MAAM,WAAW,uBAAuB,CAAC;AAChD,eAAO,MAAM,WAAW,EAAE,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,CAG7D,CAAC;AAEF,eAAO,MAAM,QAAQ,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,WACP,CAAC;AAErC;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAMvD;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,sEAAsE;IACtE,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC;IACpC,uDAAuD;IACvD,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;CACvC;AAED,MAAM,MAAM,cAAc,GACtB;IACE,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAClB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,gDAAgD;IAChD,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,SAAS,WAAW,EAAE,CAAC;CACxC,GACD;IAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAEpD;;;GAGG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,MAAM,EAAE,CAEtE;AAUD,wBAAgB,QAAQ,CACtB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,WAAW,EACnB,EAAE,gBAAoC,EAAE,GAAE;IAAE,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAAO,GAC3E,cAAc,CAsChB;AAED,iGAAiG;AACjG,wBAAgB,cAAc,CAC5B,MAAM,EAAE,cAAc,EACtB,IAAI,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,GAC1B,MAAM,EAAE,CAYV"}
|
package/dist/new-paper.js
CHANGED
|
@@ -19,7 +19,7 @@ import { existsSync, mkdirSync, readFileSync, statSync, writeFileSync, } from "n
|
|
|
19
19
|
/* eslint-enable boundaries/dependencies */
|
|
20
20
|
import { join } from "node:path";
|
|
21
21
|
import { fileURLToPath } from "node:url";
|
|
22
|
-
import {
|
|
22
|
+
import { CONFIG_FILE } from "../lib/paper-config.mjs";
|
|
23
23
|
export const FORMATS = ["tex", "md"];
|
|
24
24
|
export const DEFAULT_FORMAT = "tex";
|
|
25
25
|
/** The package's default templates. Read from disk, so they ship in the tarball (`files`). */
|
|
@@ -53,23 +53,12 @@ export function nameProblem(name) {
|
|
|
53
53
|
* already has a source in EITHER format, in which case that one stands — and `paperlint.json`.
|
|
54
54
|
*/
|
|
55
55
|
export function wantedFiles(dir, format) {
|
|
56
|
-
return [...scorecardAndSource(dir, format),
|
|
56
|
+
return [...scorecardAndSource(dir, format), CONFIG_FILE];
|
|
57
57
|
}
|
|
58
58
|
function scorecardAndSource(dir, format) {
|
|
59
59
|
const hasSource = Object.values(SOURCE_FILE).some((f) => existsSync(join(dir, f)));
|
|
60
60
|
return hasSource ? [STATUS_FILE] : [STATUS_FILE, SOURCE_FILE[format]];
|
|
61
61
|
}
|
|
62
|
-
/**
|
|
63
|
-
* `paperlint.json`, so that nobody has to know the file exists: its template says what to put in
|
|
64
|
-
* it, and until a venue preset is named lint says so in one warning. Not beside a pre-2.1.0
|
|
65
|
-
* `venue.json`: `paperlint init` moves that file, and a second, different one would make the move
|
|
66
|
-
* refuse.
|
|
67
|
-
*/
|
|
68
|
-
function settingsFile(dir) {
|
|
69
|
-
return existsSync(join(dir, LEGACY_PAPER_SETTINGS_FILE))
|
|
70
|
-
? []
|
|
71
|
-
: [PAPER_SETTINGS_FILE];
|
|
72
|
-
}
|
|
73
62
|
// Documented in README.md#starting-a-paper — update it when this changes.
|
|
74
63
|
export function newPaper(papersRoot, name, format, { packageTemplates = PACKAGE_TEMPLATES } = {}) {
|
|
75
64
|
const problem = nameProblem(name);
|
package/dist/new-paper.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"new-paper.js","sourceRoot":"","sources":["../src/new-paper.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,sFAAsF;AACtF,OAAO,EACL,UAAU,EACV,SAAS,EACT,YAAY,EACZ,QAAQ,EACR,aAAa,GACd,MAAM,SAAS,CAAC;AACjB,2CAA2C;AAC3C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,
|
|
1
|
+
{"version":3,"file":"new-paper.js","sourceRoot":"","sources":["../src/new-paper.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,sFAAsF;AACtF,OAAO,EACL,UAAU,EACV,SAAS,EACT,YAAY,EACZ,QAAQ,EACR,aAAa,GACd,MAAM,SAAS,CAAC;AACjB,2CAA2C;AAC3C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAGtD,MAAM,CAAC,MAAM,OAAO,GAA2B,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AAC7D,MAAM,CAAC,MAAM,cAAc,GAAgB,KAAK,CAAC;AAEjD,8FAA8F;AAC9F,MAAM,CAAC,MAAM,iBAAiB,GAAG,aAAa,CAC5C,IAAI,GAAG,CAAC,qBAAqB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAChD,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,WAAW,CAAC;AAExC,MAAM,CAAC,MAAM,WAAW,GAAG,oBAAoB,CAAC;AAChD,MAAM,CAAC,MAAM,WAAW,GAA0C;IAChE,GAAG,EAAE,WAAW;IAChB,EAAE,EAAE,UAAU;CACf,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAU,EAAoB,EAAE,CACvD,OAAO,CAAC,QAAQ,CAAC,CAAgB,CAAC,CAAC;AAErC;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC;QAC9B,OAAO,KAAK,IAAI,+GAA+G,CAAC;IAClI,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;QACtB,OAAO,KAAK,IAAI,4FAA4F,CAAC;IAC/G,OAAO,IAAI,CAAC;AACd,CAAC;AAoBD;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,GAAW,EAAE,MAAmB;IAC1D,OAAO,CAAC,GAAG,kBAAkB,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,WAAW,CAAC,CAAC;AAC3D,CAAC;AAED,SAAS,kBAAkB,CAAC,GAAW,EAAE,MAAmB;IAC1D,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CACtD,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CACzB,CAAC;IACF,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;AACxE,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,QAAQ,CACtB,UAAkB,EAClB,IAAY,EACZ,MAAmB,EACnB,EAAE,gBAAgB,GAAG,iBAAiB,KAAoC,EAAE;IAE5E,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAClC,IAAI,OAAO;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;IACnD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IACnC,MAAM,KAAK,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC/B,IAAI,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE;QACxC,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,GAAG,gCAAgC,EAAE,CAAC;IAEvE,MAAM,KAAK,GAAkB,EAAE,CAAC;IAChC,MAAM,OAAO,GACX,EAAE,CAAC;IACL,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC;QAC5C,IAAI,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;YAChC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;YACrC,SAAS;QACX,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;QACrD,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;QACjD,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC;YACrC,CAAC,CAAC,CAAC,OAAO,EAAE,SAAkB,CAAC;YAC/B,CAAC,CAAC,CAAC,WAAW,EAAE,SAAkB,CAAC,CAAC;QACtC,uFAAuF;QACvF,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YAClB,OAAO;gBACL,EAAE,EAAE,KAAK;gBACT,MAAM,EAAE,mBAAmB,IAAI,KAAK,GAAG,aAAa;aACrD,CAAC;QACJ,MAAM,IAAI,GAAG,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpE,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IACrC,CAAC;IACD,4FAA4F;IAC5F,SAAS,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACpC,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,OAAO,EAAE,CAAC;QAC3C,sFAAsF;QACtF,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACvE,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAChD,CAAC;IACD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AACzC,CAAC;AAED,iGAAiG;AACjG,MAAM,UAAU,cAAc,CAC5B,MAAsB,EACtB,IAA2B;IAE3B,IAAI,CAAC,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,OAAO,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAChD,MAAM,GAAG,GAAG;QACV,KAAK,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,4CAA4C,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE;KACrG,CAAC;IACF,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,KAAK;QAC1B,GAAG,CAAC,IAAI,CACN,CAAC,CAAC,MAAM,KAAK,SAAS;YACpB,CAAC,CAAC,WAAW,CAAC,CAAC,IAAI,eAAe,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,aAAa,YAAY,GAAG,CAAC,CAAC,CAAC,SAAS,YAAY;YAC7G,CAAC,CAAC,WAAW,CAAC,CAAC,IAAI,8BAA8B,CACpD,CAAC;IACJ,OAAO,GAAG,CAAC;AACb,CAAC"}
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* THE FILES PAPERLINT OWNS — read off its own config, and made the only thing ESLint may reach.
|
|
3
|
+
*
|
|
4
|
+
* paperlint's blocks name the files they lint (`PIPELINE-STATUS.md`, `paper.md`, `paper.tex`,
|
|
5
|
+
* `reviews/*.md`, …). That list is the whole scope of `paperlint lint`, and this module turns it
|
|
6
|
+
* into two things ESLint understands:
|
|
7
|
+
*
|
|
8
|
+
* 1. **A global ignore of everything else** (`scopeToOwned`). Handing ESLint a directory is not
|
|
9
|
+
* enough: its built-in defaults lint every JavaScript file it finds, whatever our config says.
|
|
10
|
+
* Measured on a consumer project with vendored code under a paper's `repro/` folder: 1,877
|
|
11
|
+
* files, 74 errors ("'return' outside of function", "Definition for rule … was not found"),
|
|
12
|
+
* zero of them on a paper file, exit 1 — and nothing in the settings could turn it off. With
|
|
13
|
+
* the ignore, a stray script under the papers directory is never enumerated at all, and a file
|
|
14
|
+
* named on the command line can be asked about (`ESLint#isPathIgnored`) with ESLint's own
|
|
15
|
+
* matcher instead of a hand-written one.
|
|
16
|
+
*
|
|
17
|
+
* 2. **Each rule scoped to the files it was written for** (`ruleOwners` + `narrowToOwners`).
|
|
18
|
+
* One plugin NAME is bound to different plugin objects in different blocks: `paper` holds
|
|
19
|
+
* `stages`/`source`/`author-list` beside `PIPELINE-STATUS.md` and `research-question`/
|
|
20
|
+
* `typography` beside `paper.md`/`paper.tex`. So a consumer block that named `paper/source`
|
|
21
|
+
* for every file under the papers directory reached `paper.tex`, where `paper` has no `source`
|
|
22
|
+
* — and ESLint threw `Could not find "source" in plugin "paper"` from inside `lintFiles`,
|
|
23
|
+
* after paperlint's own validation had (correctly) accepted the id. A block is therefore split
|
|
24
|
+
* per owner and its `files` ANDed with the owner's (ESLint's nested-array form), so a rule can
|
|
25
|
+
* only land where its plugin is registered.
|
|
26
|
+
*
|
|
27
|
+
* ESLint's semantics that this leans on, each measured against ESLint 10 before writing it:
|
|
28
|
+
* - a global-ignore pattern that matches a DIRECTORY hides everything inside it, so directories
|
|
29
|
+
* must be un-ignored (`!` + a pattern ending in a slash) before owned files can be;
|
|
30
|
+
* - that un-ignores `node_modules/` and `.git/` too — ESLint's own defaults — so they are
|
|
31
|
+
* re-ignored after, or a `paper.md` inside a dependency would be linted;
|
|
32
|
+
* - later global-ignore patterns win, across blocks, in config order;
|
|
33
|
+
* - `files: [["a", "b"]]` matches a file only when BOTH patterns match.
|
|
34
|
+
*/
|
|
35
|
+
import type { RuleBlock, RuleEntry } from "./rules-config.ts";
|
|
36
|
+
/** A `files` entry: one glob, or several that must ALL match. */
|
|
37
|
+
export type FilesEntry = string | readonly string[];
|
|
38
|
+
/** A consumer block after narrowing: its `files` may carry ANDed pairs. */
|
|
39
|
+
export interface ScopedBlock {
|
|
40
|
+
readonly basePath: string;
|
|
41
|
+
readonly files?: readonly FilesEntry[];
|
|
42
|
+
readonly ignores?: readonly string[];
|
|
43
|
+
readonly rules: Readonly<Record<string, RuleEntry>>;
|
|
44
|
+
}
|
|
45
|
+
/** Every glob paperlint's own blocks lint, once, in config order. */
|
|
46
|
+
export declare function ownedPatterns(own: readonly unknown[]): string[];
|
|
47
|
+
/** A global-ignore block that leaves ESLint nothing to lint but `owned`. */
|
|
48
|
+
export declare function scopeToOwned(owned: readonly string[]): {
|
|
49
|
+
readonly ignores: string[];
|
|
50
|
+
};
|
|
51
|
+
/**
|
|
52
|
+
* Rule id → the globs of the blocks that register its plugin with that rule. `null`: the plugin
|
|
53
|
+
* is registered for every file (a block without `files`), so the rule resolves anywhere.
|
|
54
|
+
*/
|
|
55
|
+
export declare function ruleOwners(own: readonly unknown[]): Map<string, readonly string[] | null>;
|
|
56
|
+
/**
|
|
57
|
+
* One consumer block → one block per owner, each carrying only that owner's rules, its `files`
|
|
58
|
+
* ANDed with the owner's globs. A rule no block of this config registers (the LaTeX block is
|
|
59
|
+
* absent when its parser did not load) gets no block: it has no file to reach in this run, and
|
|
60
|
+
* naming it to ESLint would only crash.
|
|
61
|
+
*/
|
|
62
|
+
export declare function narrowToOwners(block: RuleBlock, owners: ReadonlyMap<string, readonly string[] | null>): ScopedBlock[];
|
|
63
|
+
//# sourceMappingURL=paper-files.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"paper-files.d.ts","sourceRoot":"","sources":["../src/paper-files.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAU9D,iEAAiE;AACjE,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,SAAS,MAAM,EAAE,CAAC;AAEpD,2EAA2E;AAC3E,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;IACvC,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;CACrD;AAKD,qEAAqE;AACrE,wBAAgB,aAAa,CAAC,GAAG,EAAE,SAAS,OAAO,EAAE,GAAG,MAAM,EAAE,CAE/D;AAKD,4EAA4E;AAC5E,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG;IACtD,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;CAC5B,CASA;AAiBD;;;GAGG;AACH,wBAAgB,UAAU,CACxB,GAAG,EAAE,SAAS,OAAO,EAAE,GACtB,GAAG,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAAC,CAQvC;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,KAAK,EAAE,SAAS,EAChB,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAAC,GACpD,WAAW,EAAE,CAuBf"}
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
const globsOf = (b) => (b.files ?? []).filter((f) => typeof f === "string");
|
|
2
|
+
/** Every glob paperlint's own blocks lint, once, in config order. */
|
|
3
|
+
export function ownedPatterns(own) {
|
|
4
|
+
return [...new Set(own.flatMap((b) => globsOf(b)))];
|
|
5
|
+
}
|
|
6
|
+
/** ESLint's default ignores, re-applied after directories are un-ignored. */
|
|
7
|
+
const ESLINT_DEFAULT_IGNORES = ["**/node_modules/", "**/.git/"];
|
|
8
|
+
/** A global-ignore block that leaves ESLint nothing to lint but `owned`. */
|
|
9
|
+
export function scopeToOwned(owned) {
|
|
10
|
+
return {
|
|
11
|
+
ignores: [
|
|
12
|
+
"**/*",
|
|
13
|
+
"!**/*/",
|
|
14
|
+
...owned.map((p) => `!${p}`),
|
|
15
|
+
...ESLINT_DEFAULT_IGNORES,
|
|
16
|
+
],
|
|
17
|
+
};
|
|
18
|
+
}
|
|
19
|
+
/** Every `<plugin>/<rule>` a block registers. */
|
|
20
|
+
const ruleIdsOf = (b) => Object.entries(b.plugins ?? {}).flatMap(([name, plugin]) => Object.keys(plugin.rules ?? {}).map((rule) => `${name}/${rule}`));
|
|
21
|
+
/** An owner seen so far, widened by one more block's globs; `null` (every file) absorbs all. */
|
|
22
|
+
const widen = (had, files) => had === null || files === null
|
|
23
|
+
? null
|
|
24
|
+
: [...new Set([...(had ?? []), ...files])];
|
|
25
|
+
/**
|
|
26
|
+
* Rule id → the globs of the blocks that register its plugin with that rule. `null`: the plugin
|
|
27
|
+
* is registered for every file (a block without `files`), so the rule resolves anywhere.
|
|
28
|
+
*/
|
|
29
|
+
export function ruleOwners(own) {
|
|
30
|
+
const owners = new Map();
|
|
31
|
+
for (const raw of own) {
|
|
32
|
+
const b = raw;
|
|
33
|
+
const files = b.files ? globsOf(b) : null;
|
|
34
|
+
for (const id of ruleIdsOf(b))
|
|
35
|
+
owners.set(id, widen(owners.get(id), files));
|
|
36
|
+
}
|
|
37
|
+
return owners;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* One consumer block → one block per owner, each carrying only that owner's rules, its `files`
|
|
41
|
+
* ANDed with the owner's globs. A rule no block of this config registers (the LaTeX block is
|
|
42
|
+
* absent when its parser did not load) gets no block: it has no file to reach in this run, and
|
|
43
|
+
* naming it to ESLint would only crash.
|
|
44
|
+
*/
|
|
45
|
+
export function narrowToOwners(block, owners) {
|
|
46
|
+
const groups = new Map();
|
|
47
|
+
for (const [id, entry] of Object.entries(block.rules)) {
|
|
48
|
+
const owner = owners.get(id);
|
|
49
|
+
if (owner === undefined)
|
|
50
|
+
continue;
|
|
51
|
+
const key = JSON.stringify(owner);
|
|
52
|
+
groups.set(key, { ...groups.get(key), [id]: entry });
|
|
53
|
+
}
|
|
54
|
+
return [...groups].map(([key, rules]) => {
|
|
55
|
+
const owner = JSON.parse(key);
|
|
56
|
+
const files = owner === null
|
|
57
|
+
? block.files
|
|
58
|
+
: block.files
|
|
59
|
+
? block.files.flatMap((f) => owner.map((o) => [f, o]))
|
|
60
|
+
: owner;
|
|
61
|
+
return {
|
|
62
|
+
basePath: block.basePath,
|
|
63
|
+
...(files ? { files } : {}),
|
|
64
|
+
...(block.ignores ? { ignores: block.ignores } : {}),
|
|
65
|
+
rules,
|
|
66
|
+
};
|
|
67
|
+
});
|
|
68
|
+
}
|
|
69
|
+
//# sourceMappingURL=paper-files.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"paper-files.js","sourceRoot":"","sources":["../src/paper-files.ts"],"names":[],"mappings":"AAuDA,MAAM,OAAO,GAAG,CAAC,CAAQ,EAAY,EAAE,CACrC,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC;AAEpE,qEAAqE;AACrE,MAAM,UAAU,aAAa,CAAC,GAAuB;IACnD,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,6EAA6E;AAC7E,MAAM,sBAAsB,GAAG,CAAC,kBAAkB,EAAE,UAAU,CAAC,CAAC;AAEhE,4EAA4E;AAC5E,MAAM,UAAU,YAAY,CAAC,KAAwB;IAGnD,OAAO;QACL,OAAO,EAAE;YACP,MAAM;YACN,QAAQ;YACR,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5B,GAAG,sBAAsB;SAC1B;KACF,CAAC;AACJ,CAAC;AAED,iDAAiD;AACjD,MAAM,SAAS,GAAG,CAAC,CAAQ,EAAY,EAAE,CACvC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE,CACzD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC,CACjE,CAAC;AAEJ,gGAAgG;AAChG,MAAM,KAAK,GAAG,CACZ,GAAyC,EACzC,KAA+B,EACL,EAAE,CAC5B,GAAG,KAAK,IAAI,IAAI,KAAK,KAAK,IAAI;IAC5B,CAAC,CAAC,IAAI;IACN,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;AAE/C;;;GAGG;AACH,MAAM,UAAU,UAAU,CACxB,GAAuB;IAEvB,MAAM,MAAM,GAAG,IAAI,GAAG,EAAoC,CAAC;IAC3D,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;QACtB,MAAM,CAAC,GAAG,GAAY,CAAC;QACvB,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC1C,KAAK,MAAM,EAAE,IAAI,SAAS,CAAC,CAAC,CAAC;YAAE,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IAC9E,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAC5B,KAAgB,EAChB,MAAqD;IAErD,MAAM,MAAM,GAAG,IAAI,GAAG,EAAqC,CAAC;IAC5D,KAAK,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QACtD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC7B,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QAClC,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAClC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACtC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAoB,CAAC;QACjD,MAAM,KAAK,GACT,KAAK,KAAK,IAAI;YACZ,CAAC,CAAC,KAAK,CAAC,KAAK;YACb,CAAC,CAAC,KAAK,CAAC,KAAK;gBACX,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBACtD,CAAC,CAAC,KAAK,CAAC;QACd,OAAO;YACL,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3B,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACpD,KAAK;SACN,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC"}
|
package/dist/paper-settings.d.ts
CHANGED
|
@@ -9,60 +9,32 @@ export interface PaperSettings {
|
|
|
9
9
|
readonly kind: string | null;
|
|
10
10
|
/** The built PDF relative to the paper, when it is not `paper.pdf`. */
|
|
11
11
|
readonly pdf: string | null;
|
|
12
|
-
/**
|
|
13
|
-
|
|
12
|
+
/**
|
|
13
|
+
* Rule overrides for this paper alone — `{ id: severity }` or ESLint blocks — NOT yet checked
|
|
14
|
+
* against the shipped rules.
|
|
15
|
+
*/
|
|
16
|
+
readonly rules: Readonly<Record<string, unknown>> | readonly unknown[] | null;
|
|
14
17
|
}
|
|
15
18
|
/** Why a paper's settings cannot be read. */
|
|
16
19
|
export type SettingsProblem = {
|
|
17
20
|
readonly kind: "broken";
|
|
18
21
|
readonly why: string;
|
|
19
|
-
} | {
|
|
20
|
-
readonly kind: "legacy";
|
|
21
22
|
};
|
|
23
|
+
declare const STRING_FIELDS: readonly ["extends", "kind", "pdf"];
|
|
24
|
+
/** `extends`, `kind` and `pdf`, each null when absent. The root file's defaults parse the same way. */
|
|
25
|
+
export declare function stringFields(d: Readonly<Record<string, unknown>>): Result<Pick<PaperSettings, (typeof STRING_FIELDS)[number]>, string>;
|
|
22
26
|
/** The parsed JSON of `paperlint.json` → the settings, or one line saying what is wrong. Pure. */
|
|
23
27
|
export declare function parsePaperSettings(json: unknown): Result<PaperSettings, string>;
|
|
24
28
|
/**
|
|
25
|
-
* A paper's settings
|
|
26
|
-
*
|
|
29
|
+
* A paper's settings, its own `paperlint.json` merged over the root's defaults: null when neither
|
|
30
|
+
* says anything; the problem when a file does not parse. Reads through `files` only; never throws.
|
|
27
31
|
*/
|
|
28
32
|
export declare function readPaperSettings(files: Files, paperDir: string): Result<PaperSettings | null, SettingsProblem>;
|
|
29
|
-
/** What `paperlint init` does with one paper's files. */
|
|
30
|
-
export type Migration =
|
|
31
|
-
/** No `venue.json`: nothing to do. */
|
|
32
|
-
{
|
|
33
|
-
readonly kind: "none";
|
|
34
|
-
}
|
|
35
|
-
/** Only `venue.json`: write `text` as `paperlint.json`, delete `venue.json`. */
|
|
36
|
-
| {
|
|
37
|
-
readonly kind: "move";
|
|
38
|
-
readonly text: string;
|
|
39
|
-
}
|
|
40
|
-
/** Both, and `paperlint.json` already says the same: the old one is a leftover, delete it. */
|
|
41
|
-
| {
|
|
42
|
-
readonly kind: "drop-legacy";
|
|
43
|
-
}
|
|
44
|
-
/** Both, and they differ: refuse — there is no way to know which one the author means. */
|
|
45
|
-
| {
|
|
46
|
-
readonly kind: "conflict";
|
|
47
|
-
}
|
|
48
|
-
/** `venue.json` is not a JSON object: refuse, naming why. */
|
|
49
|
-
| {
|
|
50
|
-
readonly kind: "broken";
|
|
51
|
-
readonly why: string;
|
|
52
|
-
};
|
|
53
|
-
/**
|
|
54
|
-
* A `venue.json` object → the `paperlint.json` object that says the same, in one move:
|
|
55
|
-
* `"venue": "aisec"` becomes `"extends": "paperlint:aisec"` (the only presets that existed were the
|
|
56
|
-
* shipped ones), and the `"_"` some files used as a comment becomes `"$comment"`. Every other key
|
|
57
|
-
* is carried as it is — an unknown one is then refused by name, as in any `paperlint.json`. Pure.
|
|
58
|
-
*/
|
|
59
|
-
export declare function fromLegacy(legacy: Readonly<Record<string, unknown>>): Record<string, unknown>;
|
|
60
|
-
/** The move, planned from the two files' bytes (null = absent). Pure. */
|
|
61
|
-
export declare function migrationOf(legacy: Uint8Array | null, current: Uint8Array | null): Migration;
|
|
62
33
|
/**
|
|
63
34
|
* `rules` → the parsed entries (rule id → severity or `[severity, options]`), or the error naming
|
|
64
|
-
* the file. Null when the paper sets none.
|
|
65
|
-
* (`paperRuleBlocks` in cli.ts)
|
|
35
|
+
* the file. Null when the paper sets none. Blocks (the list form) are parsed by the caller, which
|
|
36
|
+
* knows the file globs they are relative to (`paperRuleBlocks` in cli.ts).
|
|
66
37
|
*/
|
|
67
38
|
export declare function paperRules(paperDir: string, settings: PaperSettings, shipped: ReadonlySet<string>): Parsed<Record<string, RuleEntry> | null>;
|
|
39
|
+
export {};
|
|
68
40
|
//# sourceMappingURL=paper-settings.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"paper-settings.d.ts","sourceRoot":"","sources":["../src/paper-settings.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"paper-settings.d.ts","sourceRoot":"","sources":["../src/paper-settings.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAW,KAAK,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAEL,KAAK,MAAM,EACX,KAAK,SAAS,EACf,MAAM,mBAAmB,CAAC;AAE3B,2DAA2D;AAC3D,MAAM,WAAW,aAAa;IAC5B,2FAA2F;IAC3F,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,uEAAuE;IACvE,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,SAAS,OAAO,EAAE,GAAG,IAAI,CAAC;CAC/E;AAED,6CAA6C;AAC7C,MAAM,MAAM,eAAe,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC;AAGhF,QAAA,MAAM,aAAa,qCAAsC,CAAC;AAkB1D,uGAAuG;AACvG,wBAAgB,YAAY,CAC1B,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GACnC,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAYrE;AAED,kGAAkG;AAClG,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,OAAO,GACZ,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC,CAqB/B;AAqCD;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,MAAM,GACf,MAAM,CAAC,aAAa,GAAG,IAAI,EAAE,eAAe,CAAC,CAS/C;AAyBD;;;;GAIG;AACH,wBAAgB,UAAU,CACxB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,aAAa,EACvB,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,GAC3B,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC,CAS1C"}
|
package/dist/paper-settings.js
CHANGED
|
@@ -1,27 +1,25 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* `<paper>/paperlint.json` — ONE PAPER'S SETTINGS, parsed at the boundary.
|
|
2
|
+
* `<paper>/paperlint.json` — ONE PAPER'S SETTINGS, parsed at the boundary, merged over the root's.
|
|
3
3
|
*
|
|
4
|
-
*
|
|
4
|
+
* One file name at two levels, one schema (lib/paper-config.mjs → SETTINGS_KEYS):
|
|
5
5
|
*
|
|
6
|
-
*
|
|
6
|
+
* paperlint.json the project (optional): papersDir, rules, defaults
|
|
7
7
|
* <paper>/paperlint.json this paper: { extends, kind, pdf, rules }
|
|
8
8
|
* a venue preset `paperlint:<name>` (shipped) or `./x.jsonc` (src/presets.ts)
|
|
9
9
|
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
10
|
+
* The paper's `extends`, `kind` and `pdf` win over the root's; with no own value, the root's is
|
|
11
|
+
* the default. Every reader — the build, the facts writer, the venue rules, `paperlint lint` —
|
|
12
|
+
* goes through `readPaperSettings`, so there is one answer to "what does this paper declare".
|
|
12
13
|
*
|
|
13
14
|
* 🔴 STRICT. An unknown key is an error naming the known ones: `"venu": "aisec"` would otherwise
|
|
14
|
-
* read as "no preset", and every venue check would be silently off.
|
|
15
|
-
*
|
|
16
|
-
* 🔴 THE OLD NAME IS NOT READ. Before 2.1.0 the file was `venue.json`. A fallback would keep it
|
|
17
|
-
* working forever and leave two names for one file; instead a `venue.json` with no `paperlint.json`
|
|
18
|
-
* is an error that names `npx paperlint init`, which moves it (`migrationOf` plans that move).
|
|
15
|
+
* read as "no preset", and every venue check would be silently off. A project-only key
|
|
16
|
+
* (`papersDir`, …) in a paper's file is refused too: it would be read nowhere.
|
|
19
17
|
*/
|
|
20
|
-
import { join } from "node:path";
|
|
21
|
-
import {
|
|
18
|
+
import { dirname, join } from "node:path";
|
|
19
|
+
import { CONFIG_FILE, ROOT_ONLY_KEYS, SETTINGS_KEYS, findProjectRoot, } from "../lib/paper-config.mjs";
|
|
22
20
|
import { err, ok } from "./domain/result.js";
|
|
23
21
|
import { parseRuleEntries, } from "./rules-config.js";
|
|
24
|
-
const KNOWN = Object.keys(
|
|
22
|
+
const KNOWN = Object.keys(SETTINGS_KEYS);
|
|
25
23
|
const STRING_FIELDS = ["extends", "kind", "pdf"];
|
|
26
24
|
const isObject = (v) => typeof v === "object" && v !== null && !Array.isArray(v);
|
|
27
25
|
/** A string field: absent is null, anything but a non-empty string is the error. */
|
|
@@ -34,8 +32,8 @@ function stringField(d, k) {
|
|
|
34
32
|
? ok(v)
|
|
35
33
|
: err(`"${k}" must be a non-empty string, got ${JSON.stringify(v)}`);
|
|
36
34
|
}
|
|
37
|
-
/** `extends`, `kind` and `pdf`, each null when absent. */
|
|
38
|
-
function stringFields(d) {
|
|
35
|
+
/** `extends`, `kind` and `pdf`, each null when absent. The root file's defaults parse the same way. */
|
|
36
|
+
export function stringFields(d) {
|
|
39
37
|
const out = {};
|
|
40
38
|
for (const k of STRING_FIELDS) {
|
|
41
39
|
const f = stringField(d, k);
|
|
@@ -56,89 +54,91 @@ export function parsePaperSettings(json) {
|
|
|
56
54
|
const unknown = Object.keys(json).filter((k) => !KNOWN.includes(k));
|
|
57
55
|
if (unknown.length > 0)
|
|
58
56
|
return err(`unknown key "${unknown[0]}" — known keys: ${KNOWN.join(", ")}`);
|
|
57
|
+
const project = Object.keys(json).filter((k) => ROOT_ONLY_KEYS.includes(k));
|
|
58
|
+
if (project.length > 0)
|
|
59
|
+
return err(`"${project[0]}" is a project setting — set it in the root ${CONFIG_FILE}, not in a paper's`);
|
|
59
60
|
const fields = stringFields(json);
|
|
60
61
|
if (!fields.ok)
|
|
61
62
|
return fields;
|
|
62
63
|
const rules = json["rules"];
|
|
63
|
-
if (rules !== undefined && !isObject(rules))
|
|
64
|
-
return err(`"rules" must be an object of rule id → severity`);
|
|
64
|
+
if (rules !== undefined && !isObject(rules) && !Array.isArray(rules))
|
|
65
|
+
return err(`"rules" must be an object of rule id → severity, or a list of ESLint blocks`);
|
|
65
66
|
return ok({
|
|
66
67
|
...fields.value,
|
|
67
68
|
rules: rules ?? null,
|
|
68
69
|
});
|
|
69
70
|
}
|
|
70
71
|
const at = (p) => p;
|
|
71
|
-
/**
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
*/
|
|
75
|
-
export function readPaperSettings(files, paperDir) {
|
|
76
|
-
const bytes = files.readBytes(at(join(paperDir, PAPER_SETTINGS_FILE)));
|
|
72
|
+
/** A JSON file through `files`: undefined when absent, the problem when it does not parse. */
|
|
73
|
+
function readJson(files, path) {
|
|
74
|
+
const bytes = files.readBytes(at(path));
|
|
77
75
|
if (bytes === null)
|
|
78
|
-
return
|
|
79
|
-
null
|
|
80
|
-
? ok(null)
|
|
81
|
-
: err({ kind: "legacy" });
|
|
82
|
-
let json;
|
|
76
|
+
return ok(undefined);
|
|
83
77
|
try {
|
|
84
|
-
|
|
78
|
+
return ok(JSON.parse(new TextDecoder().decode(bytes)));
|
|
85
79
|
}
|
|
86
80
|
catch (e) {
|
|
87
81
|
return err({ kind: "broken", why: `not JSON (${e.message})` });
|
|
88
82
|
}
|
|
89
|
-
const parsed = parsePaperSettings(json);
|
|
90
|
-
return parsed.ok ? parsed : err({ kind: "broken", why: parsed.error });
|
|
91
83
|
}
|
|
92
84
|
/**
|
|
93
|
-
*
|
|
94
|
-
*
|
|
95
|
-
*
|
|
96
|
-
* is carried as it is — an unknown one is then refused by name, as in any `paperlint.json`. Pure.
|
|
85
|
+
* The root file's defaults for every paper — `extends`, `kind`, `pdf` — found by walking up from
|
|
86
|
+
* the paper's parent. None when there is no root file, or it is not an object; a root file that
|
|
87
|
+
* is wrong in another way is reported by `paperlint lint`, which parses it strictly.
|
|
97
88
|
*/
|
|
98
|
-
|
|
99
|
-
const
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
89
|
+
function rootDefaults(files, paperDir) {
|
|
90
|
+
const root = findProjectRoot(dirname(paperDir), (p) => files.isFile(at(p)));
|
|
91
|
+
const json = readJson(files, join(root, CONFIG_FILE));
|
|
92
|
+
if (!json.ok)
|
|
93
|
+
return json;
|
|
94
|
+
if (!isObject(json.value))
|
|
95
|
+
return ok(null);
|
|
96
|
+
const fields = stringFields(json.value);
|
|
97
|
+
return fields.ok
|
|
98
|
+
? fields
|
|
99
|
+
: err({ kind: "broken", why: `the root ${CONFIG_FILE}: ${fields.error}` });
|
|
109
100
|
}
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
101
|
+
/**
|
|
102
|
+
* A paper's settings, its own `paperlint.json` merged over the root's defaults: null when neither
|
|
103
|
+
* says anything; the problem when a file does not parse. Reads through `files` only; never throws.
|
|
104
|
+
*/
|
|
105
|
+
export function readPaperSettings(files, paperDir) {
|
|
106
|
+
const own = readJson(files, join(paperDir, CONFIG_FILE));
|
|
107
|
+
if (!own.ok)
|
|
108
|
+
return own;
|
|
109
|
+
const parsed = own.value === undefined ? ok(null) : parsePaperSettings(own.value);
|
|
110
|
+
if (!parsed.ok)
|
|
111
|
+
return err({ kind: "broken", why: parsed.error });
|
|
112
|
+
const defaults = rootDefaults(files, paperDir);
|
|
113
|
+
if (!defaults.ok)
|
|
114
|
+
return defaults;
|
|
115
|
+
return ok(merge(defaults.value, parsed.value));
|
|
116
|
+
}
|
|
117
|
+
const NO_DEFAULTS = { extends: null, kind: null, pdf: null };
|
|
118
|
+
/** The paper's own values win; each absent one falls back to the root's. */
|
|
119
|
+
function merge(root, paper) {
|
|
120
|
+
const r = root ?? NO_DEFAULTS;
|
|
121
|
+
const p = paper ?? { ...NO_DEFAULTS, rules: null };
|
|
122
|
+
const merged = {
|
|
123
|
+
extends: p.extends ?? r.extends,
|
|
124
|
+
kind: p.kind ?? r.kind,
|
|
125
|
+
pdf: p.pdf ?? r.pdf,
|
|
126
|
+
rules: p.rules,
|
|
127
|
+
};
|
|
128
|
+
return paper === null && Object.values(merged).every((v) => v === null)
|
|
129
|
+
? null
|
|
130
|
+
: merged;
|
|
131
131
|
}
|
|
132
132
|
// ── the paper's rule overrides ──────────────────────────────────────────────────────────
|
|
133
133
|
/**
|
|
134
134
|
* `rules` → the parsed entries (rule id → severity or `[severity, options]`), or the error naming
|
|
135
|
-
* the file. Null when the paper sets none.
|
|
136
|
-
* (`paperRuleBlocks` in cli.ts)
|
|
135
|
+
* the file. Null when the paper sets none. Blocks (the list form) are parsed by the caller, which
|
|
136
|
+
* knows the file globs they are relative to (`paperRuleBlocks` in cli.ts).
|
|
137
137
|
*/
|
|
138
138
|
export function paperRules(paperDir, settings, shipped) {
|
|
139
|
-
if (settings.rules === null)
|
|
139
|
+
if (settings.rules === null || Array.isArray(settings.rules))
|
|
140
140
|
return { ok: true, value: null };
|
|
141
|
-
const where = `${join(paperDir,
|
|
141
|
+
const where = `${join(paperDir, CONFIG_FILE)} → "rules"`;
|
|
142
142
|
return parseRuleEntries(settings.rules, where, shipped);
|
|
143
143
|
}
|
|
144
144
|
//# sourceMappingURL=paper-settings.js.map
|