@mark1russell7/conventions 0.37.0 → 0.37.1
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/README.md +63 -1
- package/build/cli.js +7 -3
- package/build/cli.js.map +1 -1
- package/build/index.d.ts +262 -43
- package/build/index.d.ts.map +1 -1
- package/build/index.js +2 -2
- package/build/{run-DWyPhbeH.js → run-DjrYJDna.js} +826 -58
- package/build/run-DjrYJDna.js.map +1 -0
- package/package.json +4 -3
- package/schema/private-names.schema.json +68 -0
- package/build/run-DWyPhbeH.js.map +0 -1
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json.schemastore.org/package",
|
|
3
3
|
"name": "@mark1russell7/conventions",
|
|
4
|
-
"version": "0.37.
|
|
4
|
+
"version": "0.37.1",
|
|
5
5
|
"description": "One check in CI for the conventions of a pnpm workspace that docs tell in prose: pinned git dependencies, source packages, tsconfig.test.json, no build output in git and more.",
|
|
6
6
|
"keywords": [
|
|
7
7
|
"conventions",
|
|
@@ -30,7 +30,8 @@
|
|
|
30
30
|
"conventions": "./build/cli.js"
|
|
31
31
|
},
|
|
32
32
|
"files": [
|
|
33
|
-
"build"
|
|
33
|
+
"build",
|
|
34
|
+
"schema"
|
|
34
35
|
],
|
|
35
36
|
"publishConfig": {
|
|
36
37
|
"access": "public"
|
|
@@ -40,7 +41,7 @@
|
|
|
40
41
|
},
|
|
41
42
|
"devDependencies": {
|
|
42
43
|
"@mark1russell7/cue": "^2.0.0",
|
|
43
|
-
"@mark1russell7/site-pages": "0.4.
|
|
44
|
+
"@mark1russell7/site-pages": "0.4.1",
|
|
44
45
|
"@types/node": "^26.6.4",
|
|
45
46
|
"tsdown": "^0.23.1",
|
|
46
47
|
"typescript": "^7.0.2",
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://unpkg.com/@mark1russell7/conventions/schema/private-names.schema.json",
|
|
4
|
+
"title": "The private name list of conventions pre-push",
|
|
5
|
+
"description": "The names of private projects that no public repository has. The file stays outside of the public repositories. The function parsePrivateNames of @mark1russell7/conventions checks the same fields.",
|
|
6
|
+
"type": "object",
|
|
7
|
+
"required": ["names"],
|
|
8
|
+
"additionalProperties": false,
|
|
9
|
+
"properties": {
|
|
10
|
+
"$schema": { "type": "string", "description": "The URL of this schema." },
|
|
11
|
+
"$comment": { "type": "string", "description": "A note for persons. The check does not read it." },
|
|
12
|
+
"names": {
|
|
13
|
+
"type": "array",
|
|
14
|
+
"description": "The private names. A break names a name by its index from 1, for example name 3 of the private name list.",
|
|
15
|
+
"items": { "$ref": "#/$defs/name" }
|
|
16
|
+
},
|
|
17
|
+
"allow": {
|
|
18
|
+
"type": "array",
|
|
19
|
+
"description": "The hits that a person examined and permitted, by repository and path.",
|
|
20
|
+
"items": { "$ref": "#/$defs/allowed" }
|
|
21
|
+
}
|
|
22
|
+
},
|
|
23
|
+
"$defs": {
|
|
24
|
+
"text": { "type": "string", "minLength": 1 },
|
|
25
|
+
"name": {
|
|
26
|
+
"type": "object",
|
|
27
|
+
"required": ["id", "project", "seeds", "patterns"],
|
|
28
|
+
"additionalProperties": false,
|
|
29
|
+
"properties": {
|
|
30
|
+
"id": { "$ref": "#/$defs/text", "description": "The short name of the entry. Each id is different. An entry of allow refers to it. The check does not show it." },
|
|
31
|
+
"project": { "$ref": "#/$defs/text", "description": "The private project of the name, as a note for persons. The check does not read it." },
|
|
32
|
+
"seeds": {
|
|
33
|
+
"type": "array",
|
|
34
|
+
"minItems": 1,
|
|
35
|
+
"items": { "$ref": "#/$defs/text" },
|
|
36
|
+
"description": "The fixed texts of the name, with case. A line with no seed of the list is no hit, so each text that a pattern or the word finds contains a seed."
|
|
37
|
+
},
|
|
38
|
+
"patterns": {
|
|
39
|
+
"type": "array",
|
|
40
|
+
"items": { "$ref": "#/$defs/text" },
|
|
41
|
+
"description": "The regular expressions of the name, in the syntax of JavaScript, with no flags. A match in a line or in a path of a file is a hit."
|
|
42
|
+
},
|
|
43
|
+
"word": {
|
|
44
|
+
"type": "string",
|
|
45
|
+
"pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$",
|
|
46
|
+
"description": "A word that is also a common word. A match of the whole word in a line is a hit only in a sentence that names the project, not in code, in a title or before a noun."
|
|
47
|
+
},
|
|
48
|
+
"commonAfter": {
|
|
49
|
+
"type": "array",
|
|
50
|
+
"items": { "type": "string", "pattern": "^[a-z]+$" },
|
|
51
|
+
"description": "The lower-case words that make the word a common word when they come next. It needs the field word."
|
|
52
|
+
}
|
|
53
|
+
},
|
|
54
|
+
"dependentRequired": { "commonAfter": ["word"] }
|
|
55
|
+
},
|
|
56
|
+
"allowed": {
|
|
57
|
+
"type": "object",
|
|
58
|
+
"required": ["repo", "path", "why"],
|
|
59
|
+
"additionalProperties": false,
|
|
60
|
+
"properties": {
|
|
61
|
+
"repo": { "$ref": "#/$defs/text", "description": "The name of the repository, or owner/name. Case is not significant." },
|
|
62
|
+
"path": { "$ref": "#/$defs/text", "description": "The path of the file from the root of the repository, with /. Case is significant." },
|
|
63
|
+
"name": { "$ref": "#/$defs/text", "description": "The id of the permitted name. With no id, each name of the list is permitted in the file." },
|
|
64
|
+
"why": { "$ref": "#/$defs/text", "description": "The reason of the person." }
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
}
|