obsidian-dev-utils 96.6.0 → 98.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/CHANGELOG.md +22 -0
- package/LICENSE +1 -1
- package/dist/integration-test-plugin/main.js +1762 -4197
- package/dist/lib/cjs/__merged.cjs +17 -9
- package/dist/lib/cjs/__merged.d.cts +3 -1
- package/dist/lib/cjs/desktop-zip-extractor.cjs +276 -0
- package/dist/lib/cjs/desktop-zip-extractor.d.cts +94 -0
- package/dist/lib/cjs/generated-during-build.cjs +1 -1
- package/dist/lib/cjs/index.cjs +4 -1
- package/dist/lib/cjs/index.d.cts +1 -0
- package/dist/lib/cjs/obsidian/components/rename-delete-handler-component.cjs +38 -38
- package/dist/lib/cjs/obsidian/demo-vault-naming.cjs +167 -0
- package/dist/lib/cjs/obsidian/demo-vault-naming.d.cts +54 -0
- package/dist/lib/cjs/obsidian/desktop-demo-vault-opener.cjs +20 -21
- package/dist/lib/cjs/obsidian/desktop-demo-vault-opener.d.cts +21 -16
- package/dist/lib/cjs/obsidian/desktop-trusted-input.cjs +9 -9
- package/dist/lib/cjs/obsidian/desktop-trusted-input.d.cts +23 -4
- package/dist/lib/cjs/obsidian/index.cjs +10 -1
- package/dist/lib/cjs/obsidian/index.d.cts +3 -0
- package/dist/lib/cjs/obsidian/mobile-trusted-input.cjs +195 -0
- package/dist/lib/cjs/obsidian/mobile-trusted-input.d.cts +93 -0
- package/dist/lib/cjs/obsidian/plugin/obsidian-plugin-repo-paths.cjs +2 -1
- package/dist/lib/cjs/obsidian/plugin/obsidian-plugin-repo-paths.d.cts +4 -0
- package/dist/lib/cjs/obsidian/resource-lock.cjs +122 -122
- package/dist/lib/cjs/obsidian/trusted-input.cjs +206 -0
- package/dist/lib/cjs/obsidian/trusted-input.d.cts +126 -0
- package/dist/lib/cjs/script-utils/build.cjs +30 -6
- package/dist/lib/cjs/script-utils/build.d.cts +5 -0
- package/dist/lib/cjs/script-utils/demo-vault.cjs +26 -6
- package/dist/lib/cjs/script-utils/demo-vault.d.cts +12 -8
- package/dist/lib/cjs/script-utils/exec.cjs +1 -1
- package/dist/lib/cjs/script-utils/formatters/dprint.cjs +3 -2
- package/dist/lib/cjs/script-utils/index.cjs +4 -1
- package/dist/lib/cjs/script-utils/index.d.cts +1 -0
- package/dist/lib/cjs/script-utils/linters/cspell.cjs +3 -3
- package/dist/lib/cjs/script-utils/linters/eslint-config.cjs +39 -1
- package/dist/lib/cjs/script-utils/linters/eslint-rules/index.cjs +16 -1
- package/dist/lib/cjs/script-utils/linters/eslint-rules/index.d.cts +5 -0
- package/dist/lib/cjs/script-utils/linters/eslint-rules/manifest-description.cjs +254 -0
- package/dist/lib/cjs/script-utils/linters/eslint-rules/manifest-description.d.cts +54 -0
- package/dist/lib/cjs/script-utils/linters/eslint-rules/manifest-helpers.cjs +217 -0
- package/dist/lib/cjs/script-utils/linters/eslint-rules/manifest-helpers.d.cts +141 -0
- package/dist/lib/cjs/script-utils/linters/eslint-rules/manifest-id.cjs +214 -0
- package/dist/lib/cjs/script-utils/linters/eslint-rules/manifest-id.d.cts +32 -0
- package/dist/lib/cjs/script-utils/linters/eslint-rules/manifest-name.cjs +215 -0
- package/dist/lib/cjs/script-utils/linters/eslint-rules/manifest-name.d.cts +30 -0
- package/dist/lib/cjs/script-utils/linters/eslint-rules/manifest-schema.cjs +318 -0
- package/dist/lib/cjs/script-utils/linters/eslint-rules/manifest-schema.d.cts +45 -0
- package/dist/lib/cjs/script-utils/linters/eslint-rules/obsidian-dev-utils-plugin.cjs +9 -1
- package/dist/lib/cjs/script-utils/linters/eslint.cjs +3 -2
- package/dist/lib/cjs/script-utils/linters/markdownlint.cjs +4 -4
- package/dist/lib/cjs/script-utils/npm-run.cjs +4 -3
- package/dist/lib/cjs/script-utils/obsidian-dev-utils-repo-paths.cjs +10 -1
- package/dist/lib/cjs/script-utils/obsidian-dev-utils-repo-paths.d.cts +37 -1
- package/dist/lib/cjs/script-utils/package-manager.cjs +287 -0
- package/dist/lib/cjs/script-utils/package-manager.d.cts +77 -0
- package/dist/lib/cjs/script-utils/version.cjs +21 -9
- package/dist/lib/esm/__merged.d.mts +3 -1
- package/dist/lib/esm/__merged.mjs +18 -10
- package/dist/lib/esm/desktop-zip-extractor.d.mts +94 -0
- package/dist/lib/esm/desktop-zip-extractor.mjs +174 -0
- package/dist/lib/esm/generated-during-build.mjs +1 -1
- package/dist/lib/esm/index.d.mts +1 -0
- package/dist/lib/esm/index.mjs +3 -1
- package/dist/lib/esm/obsidian/components/rename-delete-handler-component.mjs +38 -38
- package/dist/lib/esm/obsidian/demo-vault-naming.d.mts +54 -0
- package/dist/lib/esm/obsidian/demo-vault-naming.mjs +61 -0
- package/dist/lib/esm/obsidian/desktop-demo-vault-opener.d.mts +21 -16
- package/dist/lib/esm/obsidian/desktop-demo-vault-opener.mjs +23 -11
- package/dist/lib/esm/obsidian/desktop-trusted-input.d.mts +23 -4
- package/dist/lib/esm/obsidian/desktop-trusted-input.mjs +9 -9
- package/dist/lib/esm/obsidian/index.d.mts +3 -0
- package/dist/lib/esm/obsidian/index.mjs +7 -1
- package/dist/lib/esm/obsidian/mobile-trusted-input.d.mts +93 -0
- package/dist/lib/esm/obsidian/mobile-trusted-input.mjs +84 -0
- package/dist/lib/esm/obsidian/plugin/obsidian-plugin-repo-paths.d.mts +4 -0
- package/dist/lib/esm/obsidian/plugin/obsidian-plugin-repo-paths.mjs +2 -1
- package/dist/lib/esm/obsidian/resource-lock.mjs +122 -122
- package/dist/lib/esm/obsidian/trusted-input.d.mts +126 -0
- package/dist/lib/esm/obsidian/trusted-input.mjs +85 -0
- package/dist/lib/esm/script-utils/build.d.mts +5 -0
- package/dist/lib/esm/script-utils/build.mjs +30 -6
- package/dist/lib/esm/script-utils/demo-vault.d.mts +12 -8
- package/dist/lib/esm/script-utils/demo-vault.mjs +29 -6
- package/dist/lib/esm/script-utils/exec.mjs +1 -1
- package/dist/lib/esm/script-utils/formatters/dprint.mjs +3 -2
- package/dist/lib/esm/script-utils/index.d.mts +1 -0
- package/dist/lib/esm/script-utils/index.mjs +3 -1
- package/dist/lib/esm/script-utils/linters/cspell.mjs +3 -3
- package/dist/lib/esm/script-utils/linters/eslint-config.mjs +39 -1
- package/dist/lib/esm/script-utils/linters/eslint-rules/index.d.mts +5 -0
- package/dist/lib/esm/script-utils/linters/eslint-rules/index.mjs +11 -1
- package/dist/lib/esm/script-utils/linters/eslint-rules/manifest-description.d.mts +54 -0
- package/dist/lib/esm/script-utils/linters/eslint-rules/manifest-description.mjs +148 -0
- package/dist/lib/esm/script-utils/linters/eslint-rules/manifest-helpers.d.mts +141 -0
- package/dist/lib/esm/script-utils/linters/eslint-rules/manifest-helpers.mjs +92 -0
- package/dist/lib/esm/script-utils/linters/eslint-rules/manifest-id.d.mts +32 -0
- package/dist/lib/esm/script-utils/linters/eslint-rules/manifest-id.mjs +111 -0
- package/dist/lib/esm/script-utils/linters/eslint-rules/manifest-name.d.mts +30 -0
- package/dist/lib/esm/script-utils/linters/eslint-rules/manifest-name.mjs +112 -0
- package/dist/lib/esm/script-utils/linters/eslint-rules/manifest-schema.d.mts +45 -0
- package/dist/lib/esm/script-utils/linters/eslint-rules/manifest-schema.mjs +217 -0
- package/dist/lib/esm/script-utils/linters/eslint-rules/obsidian-dev-utils-plugin.mjs +9 -1
- package/dist/lib/esm/script-utils/linters/eslint.mjs +3 -2
- package/dist/lib/esm/script-utils/linters/markdownlint.mjs +4 -4
- package/dist/lib/esm/script-utils/npm-run.mjs +4 -3
- package/dist/lib/esm/script-utils/obsidian-dev-utils-repo-paths.d.mts +37 -1
- package/dist/lib/esm/script-utils/obsidian-dev-utils-repo-paths.mjs +10 -1
- package/dist/lib/esm/script-utils/package-manager.d.mts +77 -0
- package/dist/lib/esm/script-utils/package-manager.mjs +173 -0
- package/dist/lib/esm/script-utils/version.mjs +21 -9
- package/obsidian/demo-vault-naming/package.json +6 -0
- package/obsidian/mobile-trusted-input/package.json +6 -0
- package/obsidian/trusted-input/package.json +6 -0
- package/package.json +19 -17
- package/script-utils/linters/eslint-rules/manifest-description/package.json +6 -0
- package/script-utils/linters/eslint-rules/manifest-helpers/package.json +6 -0
- package/script-utils/linters/eslint-rules/manifest-id/package.json +6 -0
- package/script-utils/linters/eslint-rules/manifest-name/package.json +6 -0
- package/script-utils/linters/eslint-rules/manifest-schema/package.json +6 -0
- package/script-utils/package-manager/package.json +6 -0
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
/*
|
|
2
|
+
THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
|
|
3
|
+
if you want to view the source, please visit the github repository of this plugin
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
(function () {
|
|
7
|
+
function ensureBrowserProcess() {
|
|
8
|
+
const browserProcess = {
|
|
9
|
+
browser: true,
|
|
10
|
+
cwd() {
|
|
11
|
+
return '/';
|
|
12
|
+
},
|
|
13
|
+
env: {},
|
|
14
|
+
platform: 'android'
|
|
15
|
+
};
|
|
16
|
+
|
|
17
|
+
// eslint-disable-next-line obsidianmd/no-global-this, unicorn/no-unnecessary-global-this -- Must stay `globalThis`-qualified: in the emitted banner a bare `process` is a free identifier, so reading it where the host has none throws a ReferenceError instead of yielding `undefined`. That is the very case this function exists to handle.
|
|
18
|
+
const existingProcess = globalThis.process;
|
|
19
|
+
|
|
20
|
+
if (!existingProcess) {
|
|
21
|
+
// eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
|
|
22
|
+
globalThis.process = browserProcess;
|
|
23
|
+
return;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
if (existingProcess.versions?.node) {
|
|
27
|
+
return;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
const existingProcessRecord = existingProcess;
|
|
31
|
+
|
|
32
|
+
for (const [key, value] of Object.entries(browserProcess)) {
|
|
33
|
+
existingProcessRecord[key] ??= value;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
existingProcessRecord['browser'] = true;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
(function initEsm() {
|
|
40
|
+
ensureBrowserProcess();
|
|
41
|
+
})();
|
|
42
|
+
})();
|
|
43
|
+
|
|
44
|
+
import {
|
|
45
|
+
findManifestMember,
|
|
46
|
+
getManifestObject,
|
|
47
|
+
getStringValue,
|
|
48
|
+
toReportNode
|
|
49
|
+
} from "./manifest-helpers.mjs";
|
|
50
|
+
const MESSAGE_ID_CONTAINS_OBSIDIAN = "descriptionContainsObsidian";
|
|
51
|
+
const MESSAGE_ID_MISSING_PERIOD = "descriptionMissingPeriod";
|
|
52
|
+
const MESSAGE_ID_NOT_CAPITALIZED = "descriptionNotCapitalized";
|
|
53
|
+
const MESSAGE_ID_SELF_REFERENCE = "descriptionSelfReference";
|
|
54
|
+
const MESSAGE_ID_TOO_LONG = "descriptionTooLong";
|
|
55
|
+
const MESSAGE_ID_TOO_SHORT = "descriptionTooShort";
|
|
56
|
+
const MAX_DESCRIPTION_LENGTH = 250;
|
|
57
|
+
const MIN_DESCRIPTION_LENGTH = 10;
|
|
58
|
+
const OBSIDIAN_WORD = /\bobsidian\b/i;
|
|
59
|
+
const SELF_REFERENCE_PATTERNS = [
|
|
60
|
+
/\bthis plugin\b/i,
|
|
61
|
+
/\bthis is a plugin\b/i,
|
|
62
|
+
/\ba plugin (?:that|which)\b/i,
|
|
63
|
+
/^the plugin\b/i,
|
|
64
|
+
/^plugin\b/i
|
|
65
|
+
];
|
|
66
|
+
const manifestDescription = {
|
|
67
|
+
create(context) {
|
|
68
|
+
return {
|
|
69
|
+
Document(node) {
|
|
70
|
+
const manifestObject = getManifestObject(node);
|
|
71
|
+
if (!manifestObject) {
|
|
72
|
+
return;
|
|
73
|
+
}
|
|
74
|
+
const member = findManifestMember(manifestObject, "description");
|
|
75
|
+
if (!member) {
|
|
76
|
+
return;
|
|
77
|
+
}
|
|
78
|
+
const description = getStringValue(member.value);
|
|
79
|
+
if (description === null) {
|
|
80
|
+
return;
|
|
81
|
+
}
|
|
82
|
+
const reportNode = toReportNode(member.value);
|
|
83
|
+
if (OBSIDIAN_WORD.test(description)) {
|
|
84
|
+
context.report({
|
|
85
|
+
messageId: MESSAGE_ID_CONTAINS_OBSIDIAN,
|
|
86
|
+
node: reportNode
|
|
87
|
+
});
|
|
88
|
+
}
|
|
89
|
+
if (SELF_REFERENCE_PATTERNS.some((pattern) => pattern.test(description))) {
|
|
90
|
+
context.report({
|
|
91
|
+
messageId: MESSAGE_ID_SELF_REFERENCE,
|
|
92
|
+
node: reportNode
|
|
93
|
+
});
|
|
94
|
+
}
|
|
95
|
+
if (description.length < MIN_DESCRIPTION_LENGTH) {
|
|
96
|
+
context.report({
|
|
97
|
+
messageId: MESSAGE_ID_TOO_SHORT,
|
|
98
|
+
node: reportNode
|
|
99
|
+
});
|
|
100
|
+
}
|
|
101
|
+
if (description.length > MAX_DESCRIPTION_LENGTH) {
|
|
102
|
+
context.report({
|
|
103
|
+
data: { maxLength: MAX_DESCRIPTION_LENGTH.toString() },
|
|
104
|
+
messageId: MESSAGE_ID_TOO_LONG,
|
|
105
|
+
node: reportNode
|
|
106
|
+
});
|
|
107
|
+
}
|
|
108
|
+
if (!/^[A-Z]/.test(description)) {
|
|
109
|
+
context.report({
|
|
110
|
+
messageId: MESSAGE_ID_NOT_CAPITALIZED,
|
|
111
|
+
node: reportNode
|
|
112
|
+
});
|
|
113
|
+
}
|
|
114
|
+
if (!description.endsWith(".")) {
|
|
115
|
+
context.report({
|
|
116
|
+
messageId: MESSAGE_ID_MISSING_PERIOD,
|
|
117
|
+
node: reportNode
|
|
118
|
+
});
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
};
|
|
122
|
+
},
|
|
123
|
+
meta: {
|
|
124
|
+
docs: {
|
|
125
|
+
description: "Enforce the Community directory's constraints on a plugin's `manifest.json` `description`"
|
|
126
|
+
},
|
|
127
|
+
messages: {
|
|
128
|
+
[MESSAGE_ID_CONTAINS_OBSIDIAN]: "The `description` must not contain the word `Obsidian`. It is implied by the context of the plugin directory.",
|
|
129
|
+
[MESSAGE_ID_MISSING_PERIOD]: "The `description` must end with a period.",
|
|
130
|
+
[MESSAGE_ID_NOT_CAPITALIZED]: "The `description` must start with a capital letter.",
|
|
131
|
+
[MESSAGE_ID_SELF_REFERENCE]: "The `description` must not refer to itself, e.g. `this plugin` or `a plugin that`. Describe what it does instead.",
|
|
132
|
+
[MESSAGE_ID_TOO_LONG]: "The `description` must be at most {{ maxLength }} characters.",
|
|
133
|
+
[MESSAGE_ID_TOO_SHORT]: "The `description` is too short to say what the plugin does."
|
|
134
|
+
},
|
|
135
|
+
schema: [],
|
|
136
|
+
type: "problem"
|
|
137
|
+
}
|
|
138
|
+
};
|
|
139
|
+
export {
|
|
140
|
+
MESSAGE_ID_CONTAINS_OBSIDIAN,
|
|
141
|
+
MESSAGE_ID_MISSING_PERIOD,
|
|
142
|
+
MESSAGE_ID_NOT_CAPITALIZED,
|
|
143
|
+
MESSAGE_ID_SELF_REFERENCE,
|
|
144
|
+
MESSAGE_ID_TOO_LONG,
|
|
145
|
+
MESSAGE_ID_TOO_SHORT,
|
|
146
|
+
manifestDescription
|
|
147
|
+
};
|
|
148
|
+
//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../../../../src/script-utils/linters/eslint-rules/manifest-description.ts"],
  "sourcesContent": ["/**\n * @file\n *\n * ESLint rule: manifest-description\n *\n * Enforces the Community directory's constraints on a plugin's `manifest.json` `description`.\n *\n * Two of these checks deliberately diverge from `obsidianmd/validate-manifest`:\n *\n * - **Self-reference, not the word `plugin`.** Upstream's `FORBIDDEN_WORDS` bans the bare substring\n *   `plugin` in the description, which rejects two descriptions the directory itself passed untouched -\n *   `Enhances Note composer core plugin.` and `...not plugin updates...` - because each names something\n *   other than itself. The directory's actual objection is self-reference, so only self-referential\n *   phrases are matched here.\n * - **No character whitelist.** Upstream's format check rejects anything outside\n *   `[A-Za-z0-9\\s.,!?'\"-]`, which fails backticks, em dashes, parentheses, colons and slashes. Seven\n *   live listings carry those and the directory flagged none, so the check is noise rather than a gate.\n *\n * The no-`Obsidian` check has the opposite provenance: the directory enforces it and no Obsidian\n * document states it, which is what cost a released plugin a version bump for one word.\n *\n * Runs on the `@eslint/json` `json/json` language; see `manifest-helpers.ts` for why the AST is Momoa\n * rather than ESTree.\n */\n\nimport type { Rule } from 'eslint';\n\nimport {\n  findManifestMember,\n  getManifestObject,\n  getStringValue,\n  toReportNode\n} from './manifest-helpers.ts';\n\n/**\nMessage ID reported when the description contains the word `Obsidian`.\n */\nexport const MESSAGE_ID_CONTAINS_OBSIDIAN = 'descriptionContainsObsidian';\n\n/**\nMessage ID reported when the description does not end with a period.\n */\nexport const MESSAGE_ID_MISSING_PERIOD = 'descriptionMissingPeriod';\n\n/**\nMessage ID reported when the description does not start with a capital letter.\n */\nexport const MESSAGE_ID_NOT_CAPITALIZED = 'descriptionNotCapitalized';\n\n/**\nMessage ID reported when the description refers to itself.\n */\nexport const MESSAGE_ID_SELF_REFERENCE = 'descriptionSelfReference';\n\n/**\nMessage ID reported when the description is longer than the directory allows.\n */\nexport const MESSAGE_ID_TOO_LONG = 'descriptionTooLong';\n\n/**\nMessage ID reported when the description is too short to describe anything.\n */\nexport const MESSAGE_ID_TOO_SHORT = 'descriptionTooShort';\n\n/**\nThe longest description the Community directory accepts.\n */\nconst MAX_DESCRIPTION_LENGTH = 250;\n\n/**\nThe shortest description that can plausibly say what a plugin does.\n */\nconst MIN_DESCRIPTION_LENGTH = 10;\n\n/**\nThe word `Obsidian`, which the directory rejects in a description even though no Obsidian document says so.\n */\nconst OBSIDIAN_WORD = /\\bobsidian\\b/i;\n\n/**\nThe phrasings the directory calls out as self-reference. A bare `plugin` is deliberately not among them:\nnaming another plugin, or plugins in general, is not referring to oneself.\n */\nconst SELF_REFERENCE_PATTERNS = [\n  /\\bthis plugin\\b/i,\n  /\\bthis is a plugin\\b/i,\n  /\\ba plugin (?:that|which)\\b/i,\n  /^the plugin\\b/i,\n  /^plugin\\b/i\n];\n\n/**\n * ESLint rule enforcing the Community directory's constraints on a plugin's `manifest.json` `description`.\n */\nexport const manifestDescription: Rule.RuleModule = {\n  create(context) {\n    return {\n      Document(node: unknown): void {\n        const manifestObject = getManifestObject(node);\n\n        if (!manifestObject) {\n          return;\n        }\n\n        const member = findManifestMember(manifestObject, 'description');\n\n        if (!member) {\n          return;\n        }\n\n        const description = getStringValue(member.value);\n\n        if (description === null) {\n          return;\n        }\n\n        const reportNode = toReportNode(member.value);\n\n        if (OBSIDIAN_WORD.test(description)) {\n          context.report({\n            messageId: MESSAGE_ID_CONTAINS_OBSIDIAN,\n            node: reportNode\n          });\n        }\n\n        if (SELF_REFERENCE_PATTERNS.some((pattern) => pattern.test(description))) {\n          context.report({\n            messageId: MESSAGE_ID_SELF_REFERENCE,\n            node: reportNode\n          });\n        }\n\n        if (description.length < MIN_DESCRIPTION_LENGTH) {\n          context.report({\n            messageId: MESSAGE_ID_TOO_SHORT,\n            node: reportNode\n          });\n        }\n\n        if (description.length > MAX_DESCRIPTION_LENGTH) {\n          context.report({\n            data: { maxLength: MAX_DESCRIPTION_LENGTH.toString() },\n            messageId: MESSAGE_ID_TOO_LONG,\n            node: reportNode\n          });\n        }\n\n        if (!/^[A-Z]/.test(description)) {\n          context.report({\n            messageId: MESSAGE_ID_NOT_CAPITALIZED,\n            node: reportNode\n          });\n        }\n\n        if (!description.endsWith('.')) {\n          context.report({\n            messageId: MESSAGE_ID_MISSING_PERIOD,\n            node: reportNode\n          });\n        }\n      }\n    };\n  },\n  meta: {\n    docs: {\n      description: 'Enforce the Community directory\\'s constraints on a plugin\\'s `manifest.json` `description`'\n    },\n    messages: {\n      [MESSAGE_ID_CONTAINS_OBSIDIAN]: 'The `description` must not contain the word `Obsidian`. It is implied by the context of the plugin directory.',\n      [MESSAGE_ID_MISSING_PERIOD]: 'The `description` must end with a period.',\n      [MESSAGE_ID_NOT_CAPITALIZED]: 'The `description` must start with a capital letter.',\n      [MESSAGE_ID_SELF_REFERENCE]: 'The `description` must not refer to itself, e.g. `this plugin` or `a plugin that`. Describe what it does instead.',\n      [MESSAGE_ID_TOO_LONG]: 'The `description` must be at most {{ maxLength }} characters.',\n      [MESSAGE_ID_TOO_SHORT]: 'The `description` is too short to say what the plugin does.'\n    },\n    schema: [],\n    type: 'problem'\n  }\n};\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAKA,MAAM,+BAA+B;AAKrC,MAAM,4BAA4B;AAKlC,MAAM,6BAA6B;AAKnC,MAAM,4BAA4B;AAKlC,MAAM,sBAAsB;AAK5B,MAAM,uBAAuB;AAKpC,MAAM,yBAAyB;AAK/B,MAAM,yBAAyB;AAK/B,MAAM,gBAAgB;AAMtB,MAAM,0BAA0B;AAAA,EAC9B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAKO,MAAM,sBAAuC;AAAA,EAClD,OAAO,SAAS;AACd,WAAO;AAAA,MACL,SAAS,MAAqB;AAC5B,cAAM,iBAAiB,kBAAkB,IAAI;AAE7C,YAAI,CAAC,gBAAgB;AACnB;AAAA,QACF;AAEA,cAAM,SAAS,mBAAmB,gBAAgB,aAAa;AAE/D,YAAI,CAAC,QAAQ;AACX;AAAA,QACF;AAEA,cAAM,cAAc,eAAe,OAAO,KAAK;AAE/C,YAAI,gBAAgB,MAAM;AACxB;AAAA,QACF;AAEA,cAAM,aAAa,aAAa,OAAO,KAAK;AAE5C,YAAI,cAAc,KAAK,WAAW,GAAG;AACnC,kBAAQ,OAAO;AAAA,YACb,WAAW;AAAA,YACX,MAAM;AAAA,UACR,CAAC;AAAA,QACH;AAEA,YAAI,wBAAwB,KAAK,CAAC,YAAY,QAAQ,KAAK,WAAW,CAAC,GAAG;AACxE,kBAAQ,OAAO;AAAA,YACb,WAAW;AAAA,YACX,MAAM;AAAA,UACR,CAAC;AAAA,QACH;AAEA,YAAI,YAAY,SAAS,wBAAwB;AAC/C,kBAAQ,OAAO;AAAA,YACb,WAAW;AAAA,YACX,MAAM;AAAA,UACR,CAAC;AAAA,QACH;AAEA,YAAI,YAAY,SAAS,wBAAwB;AAC/C,kBAAQ,OAAO;AAAA,YACb,MAAM,EAAE,WAAW,uBAAuB,SAAS,EAAE;AAAA,YACrD,WAAW;AAAA,YACX,MAAM;AAAA,UACR,CAAC;AAAA,QACH;AAEA,YAAI,CAAC,SAAS,KAAK,WAAW,GAAG;AAC/B,kBAAQ,OAAO;AAAA,YACb,WAAW;AAAA,YACX,MAAM;AAAA,UACR,CAAC;AAAA,QACH;AAEA,YAAI,CAAC,YAAY,SAAS,GAAG,GAAG;AAC9B,kBAAQ,OAAO;AAAA,YACb,WAAW;AAAA,YACX,MAAM;AAAA,UACR,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EACA,MAAM;AAAA,IACJ,MAAM;AAAA,MACJ,aAAa;AAAA,IACf;AAAA,IACA,UAAU;AAAA,MACR,CAAC,4BAA4B,GAAG;AAAA,MAChC,CAAC,yBAAyB,GAAG;AAAA,MAC7B,CAAC,0BAA0B,GAAG;AAAA,MAC9B,CAAC,yBAAyB,GAAG;AAAA,MAC7B,CAAC,mBAAmB,GAAG;AAAA,MACvB,CAAC,oBAAoB,GAAG;AAAA,IAC1B;AAAA,IACA,QAAQ,CAAC;AAAA,IACT,MAAM;AAAA,EACR;AACF;",
  "names": []
}

|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
/// <reference path="../../../library.d.mts" />
|
|
2
|
+
/**
|
|
3
|
+
* @file
|
|
4
|
+
*
|
|
5
|
+
* Shared helpers for the `manifest.json` ESLint rules.
|
|
6
|
+
*
|
|
7
|
+
* The manifest is linted through `@eslint/json`'s `json/json` language, whose AST is Momoa
|
|
8
|
+
* (`Document` -> `Object` -> `Member`) rather than ESTree, so these rules visit `Document` instead of
|
|
9
|
+
* `Program`. That difference is exactly why `obsidianmd/validate-manifest` can never fire: it registers a
|
|
10
|
+
* `Program` visitor and expects an ESTree `ObjectExpression`, which no shipped JSON parser produces.
|
|
11
|
+
*
|
|
12
|
+
* The Momoa node shapes are declared structurally here rather than imported from `@humanwhocodes/momoa`,
|
|
13
|
+
* which is only a transitive dependency of `@eslint/json`. A type-only import would leak into the
|
|
14
|
+
* published declarations and force every consumer to resolve a package it never installed.
|
|
15
|
+
*/
|
|
16
|
+
import type { ESLint, Rule } from 'eslint';
|
|
17
|
+
/**
|
|
18
|
+
* The Momoa node type of a JSON boolean value.
|
|
19
|
+
*/
|
|
20
|
+
export declare const JSON_NODE_TYPE_BOOLEAN = "Boolean";
|
|
21
|
+
/**
|
|
22
|
+
* The Momoa node type of a JSON object value.
|
|
23
|
+
*/
|
|
24
|
+
export declare const JSON_NODE_TYPE_OBJECT = "Object";
|
|
25
|
+
/**
|
|
26
|
+
* The Momoa node type of a JSON string value.
|
|
27
|
+
*/
|
|
28
|
+
export declare const JSON_NODE_TYPE_STRING = "String";
|
|
29
|
+
/**
|
|
30
|
+
* `@eslint/json`, typed as the plugin type a flat config and `RuleTester` are written against.
|
|
31
|
+
*
|
|
32
|
+
* The package's rule definitions are generic over its own JSON language, which `@types/eslint`'s
|
|
33
|
+
* `ESLint.Plugin` - written against ESTree rules - cannot express, so the two are nominally incompatible
|
|
34
|
+
* while being exactly compatible at runtime. Registering it is what makes `language: 'json/json'`
|
|
35
|
+
* resolvable, so there is no way to avoid the bridge.
|
|
36
|
+
*/
|
|
37
|
+
export declare const jsonPlugin: ESLint.Plugin;
|
|
38
|
+
/**
|
|
39
|
+
* The `version` a plugin repo carries before its first release, when `minAppVersion` is legitimately absent.
|
|
40
|
+
*/
|
|
41
|
+
export declare const UNRELEASED_VERSION = "0.0.0";
|
|
42
|
+
/**
|
|
43
|
+
* The root node of a parsed JSON document.
|
|
44
|
+
*/
|
|
45
|
+
export interface JsonDocumentNode extends JsonNode {
|
|
46
|
+
/**
|
|
47
|
+
* The document's single top-level value.
|
|
48
|
+
*/
|
|
49
|
+
readonly body: JsonNode;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* A JSON literal - a string, number, boolean or null.
|
|
53
|
+
*/
|
|
54
|
+
export interface JsonLiteralNode extends JsonNode {
|
|
55
|
+
/**
|
|
56
|
+
* The literal's parsed value.
|
|
57
|
+
*/
|
|
58
|
+
readonly value: boolean | null | number | string;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* A single `"key": value` pair of a JSON object.
|
|
62
|
+
*/
|
|
63
|
+
export interface JsonMemberNode extends JsonNode {
|
|
64
|
+
/**
|
|
65
|
+
* The member's key.
|
|
66
|
+
*/
|
|
67
|
+
readonly name: JsonLiteralNode;
|
|
68
|
+
/**
|
|
69
|
+
* The member's value.
|
|
70
|
+
*/
|
|
71
|
+
readonly value: JsonNode;
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* Any node of the Momoa JSON AST.
|
|
75
|
+
*/
|
|
76
|
+
export interface JsonNode {
|
|
77
|
+
/**
|
|
78
|
+
* The node type, e.g. `Document`, `Object`, `Member`, `String`.
|
|
79
|
+
*/
|
|
80
|
+
readonly type: string;
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* A JSON object value.
|
|
84
|
+
*/
|
|
85
|
+
export interface JsonObjectNode extends JsonNode {
|
|
86
|
+
/**
|
|
87
|
+
* The object's members, in source order, including any duplicate keys.
|
|
88
|
+
*/
|
|
89
|
+
readonly members: readonly JsonMemberNode[];
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* Finds a top-level member of the manifest by key.
|
|
93
|
+
*
|
|
94
|
+
* @param manifestObject - The manifest's root object node.
|
|
95
|
+
* @param key - The key to look for.
|
|
96
|
+
* @returns The first member with that key, or `null` when the manifest has none.
|
|
97
|
+
*/
|
|
98
|
+
export declare function findManifestMember(manifestObject: JsonObjectNode, key: string): JsonMemberNode | null;
|
|
99
|
+
/**
|
|
100
|
+
* Reads the manifest's root object out of the visited `Document` node.
|
|
101
|
+
*
|
|
102
|
+
* @param node - The `Document` node handed to the rule's visitor.
|
|
103
|
+
* @returns The root object node, or `null` when the document's top-level value is not an object.
|
|
104
|
+
*/
|
|
105
|
+
export declare function getManifestObject(node: unknown): JsonObjectNode | null;
|
|
106
|
+
/**
|
|
107
|
+
* Reads the value of a top-level string member of the manifest.
|
|
108
|
+
*
|
|
109
|
+
* @param manifestObject - The manifest's root object node.
|
|
110
|
+
* @param key - The key to look for.
|
|
111
|
+
* @returns The member's value, or `null` when it is absent or not a string.
|
|
112
|
+
*/
|
|
113
|
+
export declare function getManifestStringValue(manifestObject: JsonObjectNode, key: string): null | string;
|
|
114
|
+
/**
|
|
115
|
+
* Reads a member's key.
|
|
116
|
+
*
|
|
117
|
+
* Under the `json/json` language a member's name is always a string node - identifier keys exist only in
|
|
118
|
+
* JSON5 - so this never has to account for a missing key.
|
|
119
|
+
*
|
|
120
|
+
* @param member - The member to read.
|
|
121
|
+
* @returns The member's key.
|
|
122
|
+
*/
|
|
123
|
+
export declare function getMemberKey(member: JsonMemberNode): string;
|
|
124
|
+
/**
|
|
125
|
+
* Reads the value of a Momoa string node.
|
|
126
|
+
*
|
|
127
|
+
* @param node - The node to read.
|
|
128
|
+
* @returns The string value, or `null` when the node is not a string.
|
|
129
|
+
*/
|
|
130
|
+
export declare function getStringValue(node: JsonNode): null | string;
|
|
131
|
+
/**
|
|
132
|
+
* Bridges a Momoa node to the node type `context.report()` is typed against.
|
|
133
|
+
*
|
|
134
|
+
* The two are structurally incompatible - ESLint's rule types describe ESTree - but the `json/json`
|
|
135
|
+
* language's source code adapter resolves a Momoa node's position at report time, so they are compatible
|
|
136
|
+
* at runtime. This mirrors the bridge `rule-tester-helper.ts` makes over the same kind of type-level gap.
|
|
137
|
+
*
|
|
138
|
+
* @param node - The Momoa node to report on.
|
|
139
|
+
* @returns The same node, typed for `context.report()`.
|
|
140
|
+
*/
|
|
141
|
+
export declare function toReportNode(node: unknown): Rule.Node;
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
/*
|
|
2
|
+
THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
|
|
3
|
+
if you want to view the source, please visit the github repository of this plugin
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
(function () {
|
|
7
|
+
function ensureBrowserProcess() {
|
|
8
|
+
const browserProcess = {
|
|
9
|
+
browser: true,
|
|
10
|
+
cwd() {
|
|
11
|
+
return '/';
|
|
12
|
+
},
|
|
13
|
+
env: {},
|
|
14
|
+
platform: 'android'
|
|
15
|
+
};
|
|
16
|
+
|
|
17
|
+
// eslint-disable-next-line obsidianmd/no-global-this, unicorn/no-unnecessary-global-this -- Must stay `globalThis`-qualified: in the emitted banner a bare `process` is a free identifier, so reading it where the host has none throws a ReferenceError instead of yielding `undefined`. That is the very case this function exists to handle.
|
|
18
|
+
const existingProcess = globalThis.process;
|
|
19
|
+
|
|
20
|
+
if (!existingProcess) {
|
|
21
|
+
// eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
|
|
22
|
+
globalThis.process = browserProcess;
|
|
23
|
+
return;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
if (existingProcess.versions?.node) {
|
|
27
|
+
return;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
const existingProcessRecord = existingProcess;
|
|
31
|
+
|
|
32
|
+
for (const [key, value] of Object.entries(browserProcess)) {
|
|
33
|
+
existingProcessRecord[key] ??= value;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
existingProcessRecord['browser'] = true;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
(function initEsm() {
|
|
40
|
+
ensureBrowserProcess();
|
|
41
|
+
})();
|
|
42
|
+
})();
|
|
43
|
+
|
|
44
|
+
import json from "@eslint/json";
|
|
45
|
+
const JSON_NODE_TYPE_BOOLEAN = "Boolean";
|
|
46
|
+
const JSON_NODE_TYPE_OBJECT = "Object";
|
|
47
|
+
const JSON_NODE_TYPE_STRING = "String";
|
|
48
|
+
const jsonPlugin = bridgeJsonPlugin();
|
|
49
|
+
const UNRELEASED_VERSION = "0.0.0";
|
|
50
|
+
function findManifestMember(manifestObject, key) {
|
|
51
|
+
return manifestObject.members.find((member) => getMemberKey(member) === key) ?? null;
|
|
52
|
+
}
|
|
53
|
+
function getManifestObject(node) {
|
|
54
|
+
const document = node;
|
|
55
|
+
return document.body.type === JSON_NODE_TYPE_OBJECT ? document.body : null;
|
|
56
|
+
}
|
|
57
|
+
function getManifestStringValue(manifestObject, key) {
|
|
58
|
+
const member = findManifestMember(manifestObject, key);
|
|
59
|
+
return member ? getStringValue(member.value) : null;
|
|
60
|
+
}
|
|
61
|
+
function getMemberKey(member) {
|
|
62
|
+
return member.name.value;
|
|
63
|
+
}
|
|
64
|
+
function getStringValue(node) {
|
|
65
|
+
if (node.type !== JSON_NODE_TYPE_STRING) {
|
|
66
|
+
return null;
|
|
67
|
+
}
|
|
68
|
+
const literal = node;
|
|
69
|
+
return literal.value;
|
|
70
|
+
}
|
|
71
|
+
function toReportNode(node) {
|
|
72
|
+
const bridged = node;
|
|
73
|
+
return bridged;
|
|
74
|
+
}
|
|
75
|
+
function bridgeJsonPlugin() {
|
|
76
|
+
const bridged = json;
|
|
77
|
+
return bridged;
|
|
78
|
+
}
|
|
79
|
+
export {
|
|
80
|
+
JSON_NODE_TYPE_BOOLEAN,
|
|
81
|
+
JSON_NODE_TYPE_OBJECT,
|
|
82
|
+
JSON_NODE_TYPE_STRING,
|
|
83
|
+
UNRELEASED_VERSION,
|
|
84
|
+
findManifestMember,
|
|
85
|
+
getManifestObject,
|
|
86
|
+
getManifestStringValue,
|
|
87
|
+
getMemberKey,
|
|
88
|
+
getStringValue,
|
|
89
|
+
jsonPlugin,
|
|
90
|
+
toReportNode
|
|
91
|
+
};
|
|
92
|
+
//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../../../../src/script-utils/linters/eslint-rules/manifest-helpers.ts"],
  "sourcesContent": ["/**\n * @file\n *\n * Shared helpers for the `manifest.json` ESLint rules.\n *\n * The manifest is linted through `@eslint/json`'s `json/json` language, whose AST is Momoa\n * (`Document` -> `Object` -> `Member`) rather than ESTree, so these rules visit `Document` instead of\n * `Program`. That difference is exactly why `obsidianmd/validate-manifest` can never fire: it registers a\n * `Program` visitor and expects an ESTree `ObjectExpression`, which no shipped JSON parser produces.\n *\n * The Momoa node shapes are declared structurally here rather than imported from `@humanwhocodes/momoa`,\n * which is only a transitive dependency of `@eslint/json`. A type-only import would leak into the\n * published declarations and force every consumer to resolve a package it never installed.\n */\n\nimport type {\n  ESLint,\n  Rule\n} from 'eslint';\n\n// eslint-disable-next-line import-x/no-rename-default -- The default export name `plugin` is too confusing.\nimport json from '@eslint/json';\n\n/**\n * The Momoa node type of a JSON boolean value.\n */\nexport const JSON_NODE_TYPE_BOOLEAN = 'Boolean';\n\n/**\n * The Momoa node type of a JSON object value.\n */\nexport const JSON_NODE_TYPE_OBJECT = 'Object';\n\n/**\n * The Momoa node type of a JSON string value.\n */\nexport const JSON_NODE_TYPE_STRING = 'String';\n\n/**\n * `@eslint/json`, typed as the plugin type a flat config and `RuleTester` are written against.\n *\n * The package's rule definitions are generic over its own JSON language, which `@types/eslint`'s\n * `ESLint.Plugin` - written against ESTree rules - cannot express, so the two are nominally incompatible\n * while being exactly compatible at runtime. Registering it is what makes `language: 'json/json'`\n * resolvable, so there is no way to avoid the bridge.\n */\nexport const jsonPlugin: ESLint.Plugin = bridgeJsonPlugin();\n\n/**\n * The `version` a plugin repo carries before its first release, when `minAppVersion` is legitimately absent.\n */\nexport const UNRELEASED_VERSION = '0.0.0';\n\n/**\n * The root node of a parsed JSON document.\n */\nexport interface JsonDocumentNode extends JsonNode {\n  /**\n   * The document's single top-level value.\n   */\n  readonly body: JsonNode;\n}\n\n/**\n * A JSON literal - a string, number, boolean or null.\n */\nexport interface JsonLiteralNode extends JsonNode {\n  /**\n   * The literal's parsed value.\n   */\n  readonly value: boolean | null | number | string;\n}\n\n/**\n * A single `\"key\": value` pair of a JSON object.\n */\nexport interface JsonMemberNode extends JsonNode {\n  /**\n   * The member's key.\n   */\n  readonly name: JsonLiteralNode;\n\n  /**\n   * The member's value.\n   */\n  readonly value: JsonNode;\n}\n\n/**\n * Any node of the Momoa JSON AST.\n */\nexport interface JsonNode {\n  /**\n   * The node type, e.g. `Document`, `Object`, `Member`, `String`.\n   */\n  readonly type: string;\n}\n\n/**\n * A JSON object value.\n */\nexport interface JsonObjectNode extends JsonNode {\n  /**\n   * The object's members, in source order, including any duplicate keys.\n   */\n  readonly members: readonly JsonMemberNode[];\n}\n\n/**\n * Finds a top-level member of the manifest by key.\n *\n * @param manifestObject - The manifest's root object node.\n * @param key - The key to look for.\n * @returns The first member with that key, or `null` when the manifest has none.\n */\nexport function findManifestMember(manifestObject: JsonObjectNode, key: string): JsonMemberNode | null {\n  return manifestObject.members.find((member) => getMemberKey(member) === key) ?? null;\n}\n\n/**\n * Reads the manifest's root object out of the visited `Document` node.\n *\n * @param node - The `Document` node handed to the rule's visitor.\n * @returns The root object node, or `null` when the document's top-level value is not an object.\n */\nexport function getManifestObject(node: unknown): JsonObjectNode | null {\n  const document = node as JsonDocumentNode;\n  return document.body.type === JSON_NODE_TYPE_OBJECT ? document.body as JsonObjectNode : null;\n}\n\n/**\n * Reads the value of a top-level string member of the manifest.\n *\n * @param manifestObject - The manifest's root object node.\n * @param key - The key to look for.\n * @returns The member's value, or `null` when it is absent or not a string.\n */\nexport function getManifestStringValue(manifestObject: JsonObjectNode, key: string): null | string {\n  const member = findManifestMember(manifestObject, key);\n  return member ? getStringValue(member.value) : null;\n}\n\n/**\n * Reads a member's key.\n *\n * Under the `json/json` language a member's name is always a string node - identifier keys exist only in\n * JSON5 - so this never has to account for a missing key.\n *\n * @param member - The member to read.\n * @returns The member's key.\n */\nexport function getMemberKey(member: JsonMemberNode): string {\n  return member.name.value as string;\n}\n\n/**\n * Reads the value of a Momoa string node.\n *\n * @param node - The node to read.\n * @returns The string value, or `null` when the node is not a string.\n */\nexport function getStringValue(node: JsonNode): null | string {\n  if (node.type !== JSON_NODE_TYPE_STRING) {\n    return null;\n  }\n\n  const literal = node as JsonLiteralNode;\n  return literal.value as string;\n}\n\n/**\n * Bridges a Momoa node to the node type `context.report()` is typed against.\n *\n * The two are structurally incompatible - ESLint's rule types describe ESTree - but the `json/json`\n * language's source code adapter resolves a Momoa node's position at report time, so they are compatible\n * at runtime. This mirrors the bridge `rule-tester-helper.ts` makes over the same kind of type-level gap.\n *\n * @param node - The Momoa node to report on.\n * @returns The same node, typed for `context.report()`.\n */\nexport function toReportNode(node: unknown): Rule.Node {\n  const bridged: unknown = node;\n  return bridged as Rule.Node;\n}\n\n/**\n * Casts `@eslint/json` to the plugin type `@types/eslint` declares.\n *\n * @returns The `@eslint/json` plugin, typed for a flat config.\n */\nfunction bridgeJsonPlugin(): ESLint.Plugin {\n  const bridged: unknown = json;\n  return bridged as ESLint.Plugin;\n}\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqBA,OAAO,UAAU;AAKV,MAAM,yBAAyB;AAK/B,MAAM,wBAAwB;AAK9B,MAAM,wBAAwB;AAU9B,MAAM,aAA4B,iBAAiB;AAKnD,MAAM,qBAAqB;AAgE3B,SAAS,mBAAmB,gBAAgC,KAAoC;AACrG,SAAO,eAAe,QAAQ,KAAK,CAAC,WAAW,aAAa,MAAM,MAAM,GAAG,KAAK;AAClF;AAQO,SAAS,kBAAkB,MAAsC;AACtE,QAAM,WAAW;AACjB,SAAO,SAAS,KAAK,SAAS,wBAAwB,SAAS,OAAyB;AAC1F;AASO,SAAS,uBAAuB,gBAAgC,KAA4B;AACjG,QAAM,SAAS,mBAAmB,gBAAgB,GAAG;AACrD,SAAO,SAAS,eAAe,OAAO,KAAK,IAAI;AACjD;AAWO,SAAS,aAAa,QAAgC;AAC3D,SAAO,OAAO,KAAK;AACrB;AAQO,SAAS,eAAe,MAA+B;AAC5D,MAAI,KAAK,SAAS,uBAAuB;AACvC,WAAO;AAAA,EACT;AAEA,QAAM,UAAU;AAChB,SAAO,QAAQ;AACjB;AAYO,SAAS,aAAa,MAA0B;AACrD,QAAM,UAAmB;AACzB,SAAO;AACT;AAOA,SAAS,mBAAkC;AACzC,QAAM,UAAmB;AACzB,SAAO;AACT;",
  "names": []
}

|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/// <reference path="../../../library.d.mts" />
|
|
2
|
+
/**
|
|
3
|
+
* @file
|
|
4
|
+
*
|
|
5
|
+
* ESLint rule: manifest-id
|
|
6
|
+
*
|
|
7
|
+
* Enforces the Community directory's constraints on a plugin's `manifest.json` `id`: lowercase letters,
|
|
8
|
+
* digits and hyphens only; never containing `obsidian`; never ending with `plugin`.
|
|
9
|
+
*
|
|
10
|
+
* A published id can never be changed, so a violation in an already-listed plugin is permanent and the
|
|
11
|
+
* only remedy is turning this rule off for that repo with the reason written beside it.
|
|
12
|
+
*
|
|
13
|
+
* Runs on the `@eslint/json` `json/json` language; see `manifest-helpers.ts` for why the AST is Momoa
|
|
14
|
+
* rather than ESTree.
|
|
15
|
+
*/
|
|
16
|
+
import type { Rule } from 'eslint';
|
|
17
|
+
/**
|
|
18
|
+
Message ID reported when the id contains `obsidian`.
|
|
19
|
+
*/
|
|
20
|
+
export declare const MESSAGE_ID_CONTAINS_OBSIDIAN = "idContainsObsidian";
|
|
21
|
+
/**
|
|
22
|
+
Message ID reported when the id ends with `plugin`.
|
|
23
|
+
*/
|
|
24
|
+
export declare const MESSAGE_ID_ENDS_WITH_PLUGIN = "idEndsWithPlugin";
|
|
25
|
+
/**
|
|
26
|
+
Message ID reported when the id holds characters other than lowercase letters, digits and hyphens.
|
|
27
|
+
*/
|
|
28
|
+
export declare const MESSAGE_ID_INVALID_CHARACTERS = "idInvalidCharacters";
|
|
29
|
+
/**
|
|
30
|
+
* ESLint rule enforcing the Community directory's constraints on a plugin's `manifest.json` `id`.
|
|
31
|
+
*/
|
|
32
|
+
export declare const manifestId: Rule.RuleModule;
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
/*
|
|
2
|
+
THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
|
|
3
|
+
if you want to view the source, please visit the github repository of this plugin
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
(function () {
|
|
7
|
+
function ensureBrowserProcess() {
|
|
8
|
+
const browserProcess = {
|
|
9
|
+
browser: true,
|
|
10
|
+
cwd() {
|
|
11
|
+
return '/';
|
|
12
|
+
},
|
|
13
|
+
env: {},
|
|
14
|
+
platform: 'android'
|
|
15
|
+
};
|
|
16
|
+
|
|
17
|
+
// eslint-disable-next-line obsidianmd/no-global-this, unicorn/no-unnecessary-global-this -- Must stay `globalThis`-qualified: in the emitted banner a bare `process` is a free identifier, so reading it where the host has none throws a ReferenceError instead of yielding `undefined`. That is the very case this function exists to handle.
|
|
18
|
+
const existingProcess = globalThis.process;
|
|
19
|
+
|
|
20
|
+
if (!existingProcess) {
|
|
21
|
+
// eslint-disable-next-line obsidianmd/no-global-this -- Actively use globalThis.
|
|
22
|
+
globalThis.process = browserProcess;
|
|
23
|
+
return;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
if (existingProcess.versions?.node) {
|
|
27
|
+
return;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
const existingProcessRecord = existingProcess;
|
|
31
|
+
|
|
32
|
+
for (const [key, value] of Object.entries(browserProcess)) {
|
|
33
|
+
existingProcessRecord[key] ??= value;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
existingProcessRecord['browser'] = true;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
(function initEsm() {
|
|
40
|
+
ensureBrowserProcess();
|
|
41
|
+
})();
|
|
42
|
+
})();
|
|
43
|
+
|
|
44
|
+
import {
|
|
45
|
+
findManifestMember,
|
|
46
|
+
getManifestObject,
|
|
47
|
+
getStringValue,
|
|
48
|
+
toReportNode
|
|
49
|
+
} from "./manifest-helpers.mjs";
|
|
50
|
+
const MESSAGE_ID_CONTAINS_OBSIDIAN = "idContainsObsidian";
|
|
51
|
+
const MESSAGE_ID_ENDS_WITH_PLUGIN = "idEndsWithPlugin";
|
|
52
|
+
const MESSAGE_ID_INVALID_CHARACTERS = "idInvalidCharacters";
|
|
53
|
+
const ALLOWED_ID_CHARACTERS = /^[a-z0-9-]+$/;
|
|
54
|
+
const manifestId = {
|
|
55
|
+
create(context) {
|
|
56
|
+
return {
|
|
57
|
+
Document(node) {
|
|
58
|
+
const manifestObject = getManifestObject(node);
|
|
59
|
+
if (!manifestObject) {
|
|
60
|
+
return;
|
|
61
|
+
}
|
|
62
|
+
const member = findManifestMember(manifestObject, "id");
|
|
63
|
+
if (!member) {
|
|
64
|
+
return;
|
|
65
|
+
}
|
|
66
|
+
const id = getStringValue(member.value);
|
|
67
|
+
if (id === null) {
|
|
68
|
+
return;
|
|
69
|
+
}
|
|
70
|
+
const reportNode = toReportNode(member.value);
|
|
71
|
+
if (!ALLOWED_ID_CHARACTERS.test(id)) {
|
|
72
|
+
context.report({
|
|
73
|
+
messageId: MESSAGE_ID_INVALID_CHARACTERS,
|
|
74
|
+
node: reportNode
|
|
75
|
+
});
|
|
76
|
+
}
|
|
77
|
+
if (id.toLowerCase().includes("obsidian")) {
|
|
78
|
+
context.report({
|
|
79
|
+
messageId: MESSAGE_ID_CONTAINS_OBSIDIAN,
|
|
80
|
+
node: reportNode
|
|
81
|
+
});
|
|
82
|
+
}
|
|
83
|
+
if (id.toLowerCase().endsWith("plugin")) {
|
|
84
|
+
context.report({
|
|
85
|
+
messageId: MESSAGE_ID_ENDS_WITH_PLUGIN,
|
|
86
|
+
node: reportNode
|
|
87
|
+
});
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
};
|
|
91
|
+
},
|
|
92
|
+
meta: {
|
|
93
|
+
docs: {
|
|
94
|
+
description: "Enforce the Community directory's constraints on a plugin's `manifest.json` `id`"
|
|
95
|
+
},
|
|
96
|
+
messages: {
|
|
97
|
+
[MESSAGE_ID_CONTAINS_OBSIDIAN]: "The `id` must not contain `obsidian`. It is implied by the context of the plugin directory.",
|
|
98
|
+
[MESSAGE_ID_ENDS_WITH_PLUGIN]: "The `id` must not end with `plugin`.",
|
|
99
|
+
[MESSAGE_ID_INVALID_CHARACTERS]: "The `id` must contain only lowercase letters, digits and hyphens."
|
|
100
|
+
},
|
|
101
|
+
schema: [],
|
|
102
|
+
type: "problem"
|
|
103
|
+
}
|
|
104
|
+
};
|
|
105
|
+
export {
|
|
106
|
+
MESSAGE_ID_CONTAINS_OBSIDIAN,
|
|
107
|
+
MESSAGE_ID_ENDS_WITH_PLUGIN,
|
|
108
|
+
MESSAGE_ID_INVALID_CHARACTERS,
|
|
109
|
+
manifestId
|
|
110
|
+
};
|
|
111
|
+
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vLi4vLi4vc3JjL3NjcmlwdC11dGlscy9saW50ZXJzL2VzbGludC1ydWxlcy9tYW5pZmVzdC1pZC50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyoqXG4gKiBAZmlsZVxuICpcbiAqIEVTTGludCBydWxlOiBtYW5pZmVzdC1pZFxuICpcbiAqIEVuZm9yY2VzIHRoZSBDb21tdW5pdHkgZGlyZWN0b3J5J3MgY29uc3RyYWludHMgb24gYSBwbHVnaW4ncyBgbWFuaWZlc3QuanNvbmAgYGlkYDogbG93ZXJjYXNlIGxldHRlcnMsXG4gKiBkaWdpdHMgYW5kIGh5cGhlbnMgb25seTsgbmV2ZXIgY29udGFpbmluZyBgb2JzaWRpYW5gOyBuZXZlciBlbmRpbmcgd2l0aCBgcGx1Z2luYC5cbiAqXG4gKiBBIHB1Ymxpc2hlZCBpZCBjYW4gbmV2ZXIgYmUgY2hhbmdlZCwgc28gYSB2aW9sYXRpb24gaW4gYW4gYWxyZWFkeS1saXN0ZWQgcGx1Z2luIGlzIHBlcm1hbmVudCBhbmQgdGhlXG4gKiBvbmx5IHJlbWVkeSBpcyB0dXJuaW5nIHRoaXMgcnVsZSBvZmYgZm9yIHRoYXQgcmVwbyB3aXRoIHRoZSByZWFzb24gd3JpdHRlbiBiZXNpZGUgaXQuXG4gKlxuICogUnVucyBvbiB0aGUgYEBlc2xpbnQvanNvbmAgYGpzb24vanNvbmAgbGFuZ3VhZ2U7IHNlZSBgbWFuaWZlc3QtaGVscGVycy50c2AgZm9yIHdoeSB0aGUgQVNUIGlzIE1vbW9hXG4gKiByYXRoZXIgdGhhbiBFU1RyZWUuXG4gKi9cblxuaW1wb3J0IHR5cGUgeyBSdWxlIH0gZnJvbSAnZXNsaW50JztcblxuaW1wb3J0IHtcbiAgZmluZE1hbmlmZXN0TWVtYmVyLFxuICBnZXRNYW5pZmVzdE9iamVjdCxcbiAgZ2V0U3RyaW5nVmFsdWUsXG4gIHRvUmVwb3J0Tm9kZVxufSBmcm9tICcuL21hbmlmZXN0LWhlbHBlcnMudHMnO1xuXG4vKipcbk1lc3NhZ2UgSUQgcmVwb3J0ZWQgd2hlbiB0aGUgaWQgY29udGFpbnMgYG9ic2lkaWFuYC5cbiAqL1xuZXhwb3J0IGNvbnN0IE1FU1NBR0VfSURfQ09OVEFJTlNfT0JTSURJQU4gPSAnaWRDb250YWluc09ic2lkaWFuJztcblxuLyoqXG5NZXNzYWdlIElEIHJlcG9ydGVkIHdoZW4gdGhlIGlkIGVuZHMgd2l0aCBgcGx1Z2luYC5cbiAqL1xuZXhwb3J0IGNvbnN0IE1FU1NBR0VfSURfRU5EU19XSVRIX1BMVUdJTiA9ICdpZEVuZHNXaXRoUGx1Z2luJztcblxuLyoqXG5NZXNzYWdlIElEIHJlcG9ydGVkIHdoZW4gdGhlIGlkIGhvbGRzIGNoYXJhY3RlcnMgb3RoZXIgdGhhbiBsb3dlcmNhc2UgbGV0dGVycywgZGlnaXRzIGFuZCBoeXBoZW5zLlxuICovXG5leHBvcnQgY29uc3QgTUVTU0FHRV9JRF9JTlZBTElEX0NIQVJBQ1RFUlMgPSAnaWRJbnZhbGlkQ2hhcmFjdGVycyc7XG5cbi8qKlxuVGhlIG9ubHkgY2hhcmFjdGVycyBhIHBsdWdpbiBpZCBtYXkgaG9sZC5cbiAqL1xuY29uc3QgQUxMT1dFRF9JRF9DSEFSQUNURVJTID0gL15bYS16MC05LV0rJC87XG5cbi8qKlxuICogRVNMaW50IHJ1bGUgZW5mb3JjaW5nIHRoZSBDb21tdW5pdHkgZGlyZWN0b3J5J3MgY29uc3RyYWludHMgb24gYSBwbHVnaW4ncyBgbWFuaWZlc3QuanNvbmAgYGlkYC5cbiAqL1xuZXhwb3J0IGNvbnN0IG1hbmlmZXN0SWQ6IFJ1bGUuUnVsZU1vZHVsZSA9IHtcbiAgY3JlYXRlKGNvbnRleHQpIHtcbiAgICByZXR1cm4ge1xuICAgICAgRG9jdW1lbnQobm9kZTogdW5rbm93bik6IHZvaWQge1xuICAgICAgICBjb25zdCBtYW5pZmVzdE9iamVjdCA9IGdldE1hbmlmZXN0T2JqZWN0KG5vZGUpO1xuXG4gICAgICAgIGlmICghbWFuaWZlc3RPYmplY3QpIHtcbiAgICAgICAgICByZXR1cm47XG4gICAgICAgIH1cblxuICAgICAgICBjb25zdCBtZW1iZXIgPSBmaW5kTWFuaWZlc3RNZW1iZXIobWFuaWZlc3RPYmplY3QsICdpZCcpO1xuXG4gICAgICAgIGlmICghbWVtYmVyKSB7XG4gICAgICAgICAgcmV0dXJuO1xuICAgICAgICB9XG5cbiAgICAgICAgY29uc3QgaWQgPSBnZXRTdHJpbmdWYWx1ZShtZW1iZXIudmFsdWUpO1xuXG4gICAgICAgIGlmIChpZCA9PT0gbnVsbCkge1xuICAgICAgICAgIHJldHVybjtcbiAgICAgICAgfVxuXG4gICAgICAgIGNvbnN0IHJlcG9ydE5vZGUgPSB0b1JlcG9ydE5vZGUobWVtYmVyLnZhbHVlKTtcblxuICAgICAgICBpZiAoIUFMTE9XRURfSURfQ0hBUkFDVEVSUy50ZXN0KGlkKSkge1xuICAgICAgICAgIGNvbnRleHQucmVwb3J0KHtcbiAgICAgICAgICAgIG1lc3NhZ2VJZDogTUVTU0FHRV9JRF9JTlZBTElEX0NIQVJBQ1RFUlMsXG4gICAgICAgICAgICBub2RlOiByZXBvcnROb2RlXG4gICAgICAgICAgfSk7XG4gICAgICAgIH1cblxuICAgICAgICBpZiAoaWQudG9Mb3dlckNhc2UoKS5pbmNsdWRlcygnb2JzaWRpYW4nKSkge1xuICAgICAgICAgIGNvbnRleHQucmVwb3J0KHtcbiAgICAgICAgICAgIG1lc3NhZ2VJZDogTUVTU0FHRV9JRF9DT05UQUlOU19PQlNJRElBTixcbiAgICAgICAgICAgIG5vZGU6IHJlcG9ydE5vZGVcbiAgICAgICAgICB9KTtcbiAgICAgICAgfVxuXG4gICAgICAgIGlmIChpZC50b0xvd2VyQ2FzZSgpLmVuZHNXaXRoKCdwbHVnaW4nKSkge1xuICAgICAgICAgIGNvbnRleHQucmVwb3J0KHtcbiAgICAgICAgICAgIG1lc3NhZ2VJZDogTUVTU0FHRV9JRF9FTkRTX1dJVEhfUExVR0lOLFxuICAgICAgICAgICAgbm9kZTogcmVwb3J0Tm9kZVxuICAgICAgICAgIH0pO1xuICAgICAgICB9XG4gICAgICB9XG4gICAgfTtcbiAgfSxcbiAgbWV0YToge1xuICAgIGRvY3M6IHtcbiAgICAgIGRlc2NyaXB0aW9uOiAnRW5mb3JjZSB0aGUgQ29tbXVuaXR5IGRpcmVjdG9yeVxcJ3MgY29uc3RyYWludHMgb24gYSBwbHVnaW5cXCdzIGBtYW5pZmVzdC5qc29uYCBgaWRgJ1xuICAgIH0sXG4gICAgbWVzc2FnZXM6IHtcbiAgICAgIFtNRVNTQUdFX0lEX0NPTlRBSU5TX09CU0lESUFOXTogJ1RoZSBgaWRgIG11c3Qgbm90IGNvbnRhaW4gYG9ic2lkaWFuYC4gSXQgaXMgaW1wbGllZCBieSB0aGUgY29udGV4dCBvZiB0aGUgcGx1Z2luIGRpcmVjdG9yeS4nLFxuICAgICAgW01FU1NBR0VfSURfRU5EU19XSVRIX1BMVUdJTl06ICdUaGUgYGlkYCBtdXN0IG5vdCBlbmQgd2l0aCBgcGx1Z2luYC4nLFxuICAgICAgW01FU1NBR0VfSURfSU5WQUxJRF9DSEFSQUNURVJTXTogJ1RoZSBgaWRgIG11c3QgY29udGFpbiBvbmx5IGxvd2VyY2FzZSBsZXR0ZXJzLCBkaWdpdHMgYW5kIGh5cGhlbnMuJ1xuICAgIH0sXG4gICAgc2NoZW1hOiBbXSxcbiAgICB0eXBlOiAncHJvYmxlbSdcbiAgfVxufTtcbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFpQkE7QUFBQSxFQUNFO0FBQUEsRUFDQTtBQUFBLEVBQ0E7QUFBQSxFQUNBO0FBQUEsT0FDSztBQUtBLE1BQU0sK0JBQStCO0FBS3JDLE1BQU0sOEJBQThCO0FBS3BDLE1BQU0sZ0NBQWdDO0FBSzdDLE1BQU0sd0JBQXdCO0FBS3ZCLE1BQU0sYUFBOEI7QUFBQSxFQUN6QyxPQUFPLFNBQVM7QUFDZCxXQUFPO0FBQUEsTUFDTCxTQUFTLE1BQXFCO0FBQzVCLGNBQU0saUJBQWlCLGtCQUFrQixJQUFJO0FBRTdDLFlBQUksQ0FBQyxnQkFBZ0I7QUFDbkI7QUFBQSxRQUNGO0FBRUEsY0FBTSxTQUFTLG1CQUFtQixnQkFBZ0IsSUFBSTtBQUV0RCxZQUFJLENBQUMsUUFBUTtBQUNYO0FBQUEsUUFDRjtBQUVBLGNBQU0sS0FBSyxlQUFlLE9BQU8sS0FBSztBQUV0QyxZQUFJLE9BQU8sTUFBTTtBQUNmO0FBQUEsUUFDRjtBQUVBLGNBQU0sYUFBYSxhQUFhLE9BQU8sS0FBSztBQUU1QyxZQUFJLENBQUMsc0JBQXNCLEtBQUssRUFBRSxHQUFHO0FBQ25DLGtCQUFRLE9BQU87QUFBQSxZQUNiLFdBQVc7QUFBQSxZQUNYLE1BQU07QUFBQSxVQUNSLENBQUM7QUFBQSxRQUNIO0FBRUEsWUFBSSxHQUFHLFlBQVksRUFBRSxTQUFTLFVBQVUsR0FBRztBQUN6QyxrQkFBUSxPQUFPO0FBQUEsWUFDYixXQUFXO0FBQUEsWUFDWCxNQUFNO0FBQUEsVUFDUixDQUFDO0FBQUEsUUFDSDtBQUVBLFlBQUksR0FBRyxZQUFZLEVBQUUsU0FBUyxRQUFRLEdBQUc7QUFDdkMsa0JBQVEsT0FBTztBQUFBLFlBQ2IsV0FBVztBQUFBLFlBQ1gsTUFBTTtBQUFBLFVBQ1IsQ0FBQztBQUFBLFFBQ0g7QUFBQSxNQUNGO0FBQUEsSUFDRjtBQUFBLEVBQ0Y7QUFBQSxFQUNBLE1BQU07QUFBQSxJQUNKLE1BQU07QUFBQSxNQUNKLGFBQWE7QUFBQSxJQUNmO0FBQUEsSUFDQSxVQUFVO0FBQUEsTUFDUixDQUFDLDRCQUE0QixHQUFHO0FBQUEsTUFDaEMsQ0FBQywyQkFBMkIsR0FBRztBQUFBLE1BQy9CLENBQUMsNkJBQTZCLEdBQUc7QUFBQSxJQUNuQztBQUFBLElBQ0EsUUFBUSxDQUFDO0FBQUEsSUFDVCxNQUFNO0FBQUEsRUFDUjtBQUNGOyIsCiAgIm5hbWVzIjogW10KfQo=
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/// <reference path="../../../library.d.mts" />
|
|
2
|
+
/**
|
|
3
|
+
* @file
|
|
4
|
+
*
|
|
5
|
+
* ESLint rule: manifest-name
|
|
6
|
+
*
|
|
7
|
+
* Enforces the Community directory's constraints on a plugin's `manifest.json` `name`: no `Obsidian` or
|
|
8
|
+
* its variants, no `Plugin`, and Basic Latin only with hyphens, plus signs and parentheses the sole
|
|
9
|
+
* permitted punctuation.
|
|
10
|
+
*
|
|
11
|
+
* Runs on the `@eslint/json` `json/json` language; see `manifest-helpers.ts` for why the AST is Momoa
|
|
12
|
+
* rather than ESTree.
|
|
13
|
+
*/
|
|
14
|
+
import type { Rule } from 'eslint';
|
|
15
|
+
/**
|
|
16
|
+
Message ID reported when the name contains `Obsidian` or one of its variants.
|
|
17
|
+
*/
|
|
18
|
+
export declare const MESSAGE_ID_CONTAINS_OBSIDIAN = "nameContainsObsidian";
|
|
19
|
+
/**
|
|
20
|
+
Message ID reported when the name contains `Plugin`.
|
|
21
|
+
*/
|
|
22
|
+
export declare const MESSAGE_ID_CONTAINS_PLUGIN = "nameContainsPlugin";
|
|
23
|
+
/**
|
|
24
|
+
Message ID reported when the name holds a character outside Basic Latin, or punctuation the directory rejects.
|
|
25
|
+
*/
|
|
26
|
+
export declare const MESSAGE_ID_INVALID_CHARACTERS = "nameInvalidCharacters";
|
|
27
|
+
/**
|
|
28
|
+
* ESLint rule enforcing the Community directory's constraints on a plugin's `manifest.json` `name`.
|
|
29
|
+
*/
|
|
30
|
+
export declare const manifestName: Rule.RuleModule;
|