eslint-plugin-jsdoc 45.0.0 → 46.1.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.
Files changed (41) hide show
  1. package/README.md +6 -6
  2. package/dist/index.js +1 -1
  3. package/dist/index.js.map +1 -1
  4. package/dist/iterateJsdoc.js +35 -7
  5. package/dist/iterateJsdoc.js.map +1 -1
  6. package/dist/rules/noMissingSyntax.js +5 -12
  7. package/dist/rules/noMissingSyntax.js.map +1 -1
  8. package/dist/rules/noRestrictedSyntax.js +7 -18
  9. package/dist/rules/noRestrictedSyntax.js.map +1 -1
  10. package/dist/rules/requireReturns.js +19 -1
  11. package/dist/rules/requireReturns.js.map +1 -1
  12. package/docs/rules/check-examples.md +1 -1
  13. package/docs/rules/check-indentation.md +1 -1
  14. package/docs/rules/check-line-alignment.md +1 -1
  15. package/docs/rules/check-param-names.md +1 -1
  16. package/docs/rules/check-types.md +1 -1
  17. package/docs/rules/check-values.md +1 -1
  18. package/docs/rules/match-description.md +1 -1
  19. package/docs/rules/multiline-blocks.md +1 -1
  20. package/docs/rules/no-multi-asterisks.md +1 -1
  21. package/docs/rules/no-undefined-types.md +1 -1
  22. package/docs/rules/require-asterisk-prefix.md +1 -1
  23. package/docs/rules/require-description-complete-sentence.md +1 -1
  24. package/docs/rules/require-description.md +1 -1
  25. package/docs/rules/require-example.md +1 -1
  26. package/docs/rules/require-hyphen-before-param-description.md +1 -1
  27. package/docs/rules/require-param-description.md +1 -1
  28. package/docs/rules/require-param-type.md +1 -1
  29. package/docs/rules/require-param.md +1 -1
  30. package/docs/rules/require-returns-check.md +1 -1
  31. package/docs/rules/require-returns.md +28 -1
  32. package/docs/rules/require-throws.md +1 -1
  33. package/docs/rules/require-yields-check.md +1 -1
  34. package/docs/rules/require-yields.md +1 -1
  35. package/docs/rules/sort-tags.md +1 -1
  36. package/docs/rules/tag-lines.md +1 -1
  37. package/docs/rules/text-escaping.md +1 -1
  38. package/package.json +5 -2
  39. package/dist/bin/generateRule.js +0 -237
  40. package/dist/bin/generateRule.js.map +0 -1
  41. package/dist/bin/gitdown.d.ts +0 -12
@@ -1,237 +0,0 @@
1
- "use strict";
2
-
3
- var _camelcase = _interopRequireDefault(require("camelcase"));
4
- var _fs = require("fs");
5
- var _promises = _interopRequireDefault(require("fs/promises"));
6
- var _openEditor = _interopRequireDefault(require("open-editor"));
7
- var _path = require("path");
8
- function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
9
- function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
10
- function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; } /* eslint-disable no-console -- CLI */ /**
11
- * @example
12
- *
13
- * ```shell
14
- * npm run create-rule my-new-rule -- --recommended
15
- * ```
16
- */
17
- // Todo: Would ideally have prompts, e.g., to ask for whether
18
- // type was problem/layout, etc.
19
- const [,, ruleName, ...options] = process.argv;
20
- const recommended = options.includes('--recommended');
21
- (async () => {
22
- if (!ruleName) {
23
- console.error('Please supply a rule name');
24
- return;
25
- }
26
- if (/[A-Z]/u.test(ruleName)) {
27
- console.error('Please ensure the rule has no capital letters');
28
- return;
29
- }
30
- const ruleNamesPath = './test/rules/ruleNames.json';
31
- // @ts-expect-error Older types?
32
- const ruleNames = JSON.parse(await _promises.default.readFile(ruleNamesPath));
33
- if (!ruleNames.includes(ruleName)) {
34
- ruleNames.push(ruleName);
35
- ruleNames.sort();
36
- }
37
- await _promises.default.writeFile(ruleNamesPath, JSON.stringify(ruleNames, null, 2) + '\n');
38
- console.log('ruleNames', ruleNames);
39
- const ruleTemplate = `import iterateJsdoc from '../iterateJsdoc';
40
-
41
- export default iterateJsdoc(({
42
- context,
43
- utils,
44
- }) => {
45
- // Rule here
46
- }, {
47
- iterateAllJsdocs: true,
48
- meta: {
49
- docs: {
50
- description: '',
51
- url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/${ruleName}.md#repos-sticky-header',
52
- },
53
- schema: [
54
- {
55
- additionalProperties: false,
56
- properties: {
57
- // Option properties here (or remove the object)
58
- },
59
- type: 'object',
60
- },
61
- ],
62
- type: 'suggestion',
63
- },
64
- });
65
- `;
66
- const camelCasedRuleName = (0, _camelcase.default)(ruleName);
67
- const rulePath = `./src/rules/${camelCasedRuleName}.js`;
68
- if (!(0, _fs.existsSync)(rulePath)) {
69
- await _promises.default.writeFile(rulePath, ruleTemplate);
70
- }
71
- const ruleTestTemplate = `export default {
72
- invalid: [
73
- {
74
- code: \`
75
- \`,
76
- errors: [
77
- {
78
- line: 2,
79
- message: '',
80
- },
81
- ],
82
- },
83
- ],
84
- valid: [
85
- {
86
- code: \`
87
- \`,
88
- },
89
- ],
90
- };
91
- `;
92
- const ruleTestPath = `./test/rules/assertions/${camelCasedRuleName}.js`;
93
- if (!(0, _fs.existsSync)(ruleTestPath)) {
94
- await _promises.default.writeFile(ruleTestPath, ruleTestTemplate);
95
- }
96
- const ruleReadmeTemplate = `### \`${ruleName}\`
97
-
98
- |||
99
- |---|---|
100
- |Context|everywhere|
101
- |Tags|\`\`|
102
- |Recommended|${recommended ? 'true' : 'false'}|
103
- |Settings||
104
- |Options||
105
-
106
- <!-- assertions ${camelCasedRuleName} -->
107
- `;
108
- const ruleReadmePath = `./.README/rules/${ruleName}.md`;
109
- if (!(0, _fs.existsSync)(ruleReadmePath)) {
110
- await _promises.default.writeFile(ruleReadmePath, ruleReadmeTemplate);
111
- }
112
-
113
- /**
114
- * @param {object} cfg
115
- * @param {string} cfg.path
116
- * @param {RegExp} cfg.oldRegex
117
- * @param {string} cfg.checkName
118
- * @param {string} cfg.newLine
119
- * @param {boolean} [cfg.oldIsCamel]
120
- * @returns {Promise<void>}
121
- */
122
- const replaceInOrder = async ({
123
- path,
124
- oldRegex,
125
- checkName,
126
- newLine,
127
- oldIsCamel
128
- }) => {
129
- /**
130
- * @typedef {number} Integer
131
- */
132
- /**
133
- * @typedef {{
134
- * matchedLine: string,
135
- * offset: Integer,
136
- * oldRule: string,
137
- * }} OffsetInfo
138
- */
139
- /**
140
- * @type {OffsetInfo[]}
141
- */
142
- const offsets = [];
143
- let readme = await _promises.default.readFile(path, 'utf8');
144
- readme.replace(oldRegex,
145
- /**
146
- * @param {string} matchedLine
147
- * @param {string} n1
148
- * @param {Integer} offset
149
- * @param {string} str
150
- * @param {object} groups
151
- * @param {string} groups.oldRule
152
- * @returns {string}
153
- */
154
- (matchedLine, n1, offset, str, {
155
- oldRule
156
- }) => {
157
- offsets.push({
158
- matchedLine,
159
- offset,
160
- oldRule
161
- });
162
- return matchedLine;
163
- });
164
- offsets.sort(({
165
- oldRule
166
- }, {
167
- oldRule: oldRuleB
168
- }) => {
169
- return oldRule < oldRuleB ? -1 : oldRule > oldRuleB ? 1 : 0;
170
- });
171
- let alreadyIncluded = false;
172
- const itemIndex = offsets.findIndex(({
173
- oldRule
174
- }) => {
175
- alreadyIncluded ||= oldIsCamel ? camelCasedRuleName === oldRule : ruleName === oldRule;
176
- return oldIsCamel ? camelCasedRuleName < oldRule : ruleName < oldRule;
177
- });
178
- let item = itemIndex !== undefined && offsets[itemIndex];
179
- if (item && itemIndex === 0 &&
180
- // This property would not always be sufficient but in this case it is.
181
- oldIsCamel) {
182
- item.offset = 0;
183
- }
184
- if (!item) {
185
- item = /** @type {OffsetInfo} */offsets.pop();
186
- item.offset += item.matchedLine.length;
187
- }
188
- if (alreadyIncluded) {
189
- console.log(`Rule name is already present in ${checkName}.`);
190
- } else {
191
- readme = readme.slice(0, item.offset) + (item.offset ? '\n' : '') + newLine + (item.offset ? '' : '\n') + readme.slice(item.offset);
192
- await _promises.default.writeFile(path, readme);
193
- }
194
- };
195
-
196
- // await replaceInOrder({
197
- // checkName: 'README',
198
- // newLine: `{"gitdown": "include", "file": "./rules/${ruleName}.md"}`,
199
- // oldRegex: /\n\{"gitdown": "include", "file": ".\/rules\/(?<oldRule>[^.]*).md"\}/gu,
200
- // path: './.README/README.md',
201
- // });
202
-
203
- await replaceInOrder({
204
- checkName: 'index import',
205
- newLine: `import ${camelCasedRuleName} from './rules/${camelCasedRuleName}';`,
206
- oldIsCamel: true,
207
- oldRegex: /\nimport (?<oldRule>[^ ]*) from '.\/rules\/\1';/gu,
208
- path: './src/index.js'
209
- });
210
- await replaceInOrder({
211
- checkName: 'index recommended',
212
- newLine: `${' '.repeat(6)}'jsdoc/${ruleName}': ${recommended ? 'warnOrError' : '\'off\''},`,
213
- oldRegex: /\n\s{6}'jsdoc\/(?<oldRule>[^']*)': .*?,/gu,
214
- path: './src/index.js'
215
- });
216
- await replaceInOrder({
217
- checkName: 'index rules',
218
- newLine: `${' '.repeat(4)}'${ruleName}': ${camelCasedRuleName},`,
219
- oldRegex: /\n\s{4}'(?<oldRule>[^']*)': [^,]*,/gu,
220
- path: './src/index.js'
221
- });
222
- await Promise.resolve().then(() => _interopRequireWildcard(require('./generateDocs.js')));
223
-
224
- /*
225
- console.log('Paths to open for further editing\n');
226
- console.log(`open ${ruleReadmePath}`);
227
- console.log(`open ${rulePath}`);
228
- console.log(`open ${ruleTestPath}\n`);
229
- */
230
-
231
- // Set chdir as somehow still in operation from other test
232
- process.chdir((0, _path.resolve)(__dirname, '../../'));
233
- await (0, _openEditor.default)([
234
- // Could even add editor line column numbers like `${rulePath}:1:1`
235
- ruleReadmePath, ruleTestPath, rulePath]);
236
- })();
237
- //# sourceMappingURL=generateRule.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"generateRule.js","names":["_camelcase","_interopRequireDefault","require","_fs","_promises","_openEditor","_path","obj","__esModule","default","_getRequireWildcardCache","nodeInterop","WeakMap","cacheBabelInterop","cacheNodeInterop","_interopRequireWildcard","cache","has","get","newObj","hasPropertyDescriptor","Object","defineProperty","getOwnPropertyDescriptor","key","prototype","hasOwnProperty","call","desc","set","ruleName","options","process","argv","recommended","includes","console","error","test","ruleNamesPath","ruleNames","JSON","parse","fs","readFile","push","sort","writeFile","stringify","log","ruleTemplate","camelCasedRuleName","camelCase","rulePath","existsSync","ruleTestTemplate","ruleTestPath","ruleReadmeTemplate","ruleReadmePath","replaceInOrder","path","oldRegex","checkName","newLine","oldIsCamel","offsets","readme","replace","matchedLine","n1","offset","str","oldRule","oldRuleB","alreadyIncluded","itemIndex","findIndex","item","undefined","pop","length","slice","repeat","Promise","resolve","then","chdir","__dirname","open"],"sources":["../../src/bin/generateRule.js"],"sourcesContent":["/* eslint-disable no-console -- CLI */\n\n/**\n * @example\n *\n * ```shell\n * npm run create-rule my-new-rule -- --recommended\n * ```\n */\n\nimport camelCase from 'camelcase';\nimport {\n existsSync,\n} from 'fs';\nimport fs from 'fs/promises';\nimport open from 'open-editor';\nimport {\n resolve,\n} from 'path';\n\n// Todo: Would ideally have prompts, e.g., to ask for whether\n// type was problem/layout, etc.\n\nconst [\n , , ruleName,\n ...options\n] = process.argv;\n\nconst recommended = options.includes('--recommended');\n\n(async () => {\n if (!ruleName) {\n console.error('Please supply a rule name');\n\n return;\n }\n\n if ((/[A-Z]/u).test(ruleName)) {\n console.error('Please ensure the rule has no capital letters');\n\n return;\n }\n\n const ruleNamesPath = './test/rules/ruleNames.json';\n // @ts-expect-error Older types?\n const ruleNames = JSON.parse(await fs.readFile(\n ruleNamesPath,\n ));\n if (!ruleNames.includes(ruleName)) {\n ruleNames.push(ruleName);\n ruleNames.sort();\n }\n\n await fs.writeFile(ruleNamesPath, JSON.stringify(ruleNames, null, 2) + '\\n');\n console.log('ruleNames', ruleNames);\n\n const ruleTemplate = `import iterateJsdoc from '../iterateJsdoc';\n\nexport default iterateJsdoc(({\n context,\n utils,\n}) => {\n // Rule here\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: '',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/${ruleName}.md#repos-sticky-header',\n },\n schema: [\n {\n additionalProperties: false,\n properties: {\n // Option properties here (or remove the object)\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n`;\n\n const camelCasedRuleName = camelCase(ruleName);\n\n const rulePath = `./src/rules/${camelCasedRuleName}.js`;\n\n if (!existsSync(rulePath)) {\n await fs.writeFile(rulePath, ruleTemplate);\n }\n\n const ruleTestTemplate = `export default {\n invalid: [\n {\n code: \\`\n \\`,\n errors: [\n {\n line: 2,\n message: '',\n },\n ],\n },\n ],\n valid: [\n {\n code: \\`\n \\`,\n },\n ],\n};\n`;\n\n const ruleTestPath = `./test/rules/assertions/${camelCasedRuleName}.js`;\n if (!existsSync(ruleTestPath)) {\n await fs.writeFile(ruleTestPath, ruleTestTemplate);\n }\n\n const ruleReadmeTemplate = `### \\`${ruleName}\\`\n\n|||\n|---|---|\n|Context|everywhere|\n|Tags|\\`\\`|\n|Recommended|${recommended ? 'true' : 'false'}|\n|Settings||\n|Options||\n\n<!-- assertions ${camelCasedRuleName} -->\n`;\n\n const ruleReadmePath = `./.README/rules/${ruleName}.md`;\n if (!existsSync(ruleReadmePath)) {\n await fs.writeFile(ruleReadmePath, ruleReadmeTemplate);\n }\n\n /**\n * @param {object} cfg\n * @param {string} cfg.path\n * @param {RegExp} cfg.oldRegex\n * @param {string} cfg.checkName\n * @param {string} cfg.newLine\n * @param {boolean} [cfg.oldIsCamel]\n * @returns {Promise<void>}\n */\n const replaceInOrder = async ({\n path,\n oldRegex,\n checkName,\n newLine,\n oldIsCamel,\n }) => {\n /**\n * @typedef {number} Integer\n */\n /**\n * @typedef {{\n * matchedLine: string,\n * offset: Integer,\n * oldRule: string,\n * }} OffsetInfo\n */\n /**\n * @type {OffsetInfo[]}\n */\n const offsets = [];\n\n let readme = await fs.readFile(path, 'utf8');\n readme.replace(\n oldRegex,\n /**\n * @param {string} matchedLine\n * @param {string} n1\n * @param {Integer} offset\n * @param {string} str\n * @param {object} groups\n * @param {string} groups.oldRule\n * @returns {string}\n */\n (matchedLine, n1, offset, str, {\n oldRule,\n }) => {\n offsets.push({\n matchedLine,\n offset,\n oldRule,\n });\n\n return matchedLine;\n },\n );\n\n offsets.sort(({\n oldRule,\n }, {\n oldRule: oldRuleB,\n }) => {\n return oldRule < oldRuleB ? -1 : (oldRule > oldRuleB ? 1 : 0);\n });\n\n let alreadyIncluded = false;\n const itemIndex = offsets.findIndex(({\n oldRule,\n }) => {\n alreadyIncluded ||= oldIsCamel ? camelCasedRuleName === oldRule : ruleName === oldRule;\n\n return oldIsCamel ? camelCasedRuleName < oldRule : ruleName < oldRule;\n });\n let item = itemIndex !== undefined && offsets[itemIndex];\n if (item && itemIndex === 0 &&\n\n // This property would not always be sufficient but in this case it is.\n oldIsCamel\n ) {\n item.offset = 0;\n }\n\n if (!item) {\n item = /** @type {OffsetInfo} */ (offsets.pop());\n item.offset += item.matchedLine.length;\n }\n\n if (alreadyIncluded) {\n console.log(`Rule name is already present in ${checkName}.`);\n } else {\n readme = readme.slice(0, item.offset) +\n (item.offset ? '\\n' : '') +\n newLine +\n (item.offset ? '' : '\\n') +\n readme.slice(item.offset);\n\n await fs.writeFile(path, readme);\n }\n };\n\n // await replaceInOrder({\n // checkName: 'README',\n // newLine: `{\"gitdown\": \"include\", \"file\": \"./rules/${ruleName}.md\"}`,\n // oldRegex: /\\n\\{\"gitdown\": \"include\", \"file\": \".\\/rules\\/(?<oldRule>[^.]*).md\"\\}/gu,\n // path: './.README/README.md',\n // });\n\n await replaceInOrder({\n checkName: 'index import',\n newLine: `import ${camelCasedRuleName} from './rules/${camelCasedRuleName}';`,\n oldIsCamel: true,\n oldRegex: /\\nimport (?<oldRule>[^ ]*) from '.\\/rules\\/\\1';/gu,\n path: './src/index.js',\n });\n\n await replaceInOrder({\n checkName: 'index recommended',\n newLine: `${' '.repeat(6)}'jsdoc/${ruleName}': ${recommended ? 'warnOrError' : '\\'off\\''},`,\n oldRegex: /\\n\\s{6}'jsdoc\\/(?<oldRule>[^']*)': .*?,/gu,\n path: './src/index.js',\n });\n\n await replaceInOrder({\n checkName: 'index rules',\n newLine: `${' '.repeat(4)}'${ruleName}': ${camelCasedRuleName},`,\n oldRegex: /\\n\\s{4}'(?<oldRule>[^']*)': [^,]*,/gu,\n path: './src/index.js',\n });\n\n await import('./generateDocs.js');\n\n /*\n console.log('Paths to open for further editing\\n');\n console.log(`open ${ruleReadmePath}`);\n console.log(`open ${rulePath}`);\n console.log(`open ${ruleTestPath}\\n`);\n */\n\n // Set chdir as somehow still in operation from other test\n process.chdir(resolve(__dirname, '../../'));\n await open([\n // Could even add editor line column numbers like `${rulePath}:1:1`\n ruleReadmePath,\n ruleTestPath,\n rulePath,\n ]);\n})();\n"],"mappings":";;AAUA,IAAAA,UAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,GAAA,GAAAD,OAAA;AAGA,IAAAE,SAAA,GAAAH,sBAAA,CAAAC,OAAA;AACA,IAAAG,WAAA,GAAAJ,sBAAA,CAAAC,OAAA;AACA,IAAAI,KAAA,GAAAJ,OAAA;AAEc,SAAAD,uBAAAM,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,KAAAE,OAAA,EAAAF,GAAA;AAAA,SAAAG,yBAAAC,WAAA,eAAAC,OAAA,kCAAAC,iBAAA,OAAAD,OAAA,QAAAE,gBAAA,OAAAF,OAAA,YAAAF,wBAAA,YAAAA,CAAAC,WAAA,WAAAA,WAAA,GAAAG,gBAAA,GAAAD,iBAAA,KAAAF,WAAA;AAAA,SAAAI,wBAAAR,GAAA,EAAAI,WAAA,SAAAA,WAAA,IAAAJ,GAAA,IAAAA,GAAA,CAAAC,UAAA,WAAAD,GAAA,QAAAA,GAAA,oBAAAA,GAAA,wBAAAA,GAAA,4BAAAE,OAAA,EAAAF,GAAA,UAAAS,KAAA,GAAAN,wBAAA,CAAAC,WAAA,OAAAK,KAAA,IAAAA,KAAA,CAAAC,GAAA,CAAAV,GAAA,YAAAS,KAAA,CAAAE,GAAA,CAAAX,GAAA,SAAAY,MAAA,WAAAC,qBAAA,GAAAC,MAAA,CAAAC,cAAA,IAAAD,MAAA,CAAAE,wBAAA,WAAAC,GAAA,IAAAjB,GAAA,QAAAiB,GAAA,kBAAAH,MAAA,CAAAI,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAApB,GAAA,EAAAiB,GAAA,SAAAI,IAAA,GAAAR,qBAAA,GAAAC,MAAA,CAAAE,wBAAA,CAAAhB,GAAA,EAAAiB,GAAA,cAAAI,IAAA,KAAAA,IAAA,CAAAV,GAAA,IAAAU,IAAA,CAAAC,GAAA,KAAAR,MAAA,CAAAC,cAAA,CAAAH,MAAA,EAAAK,GAAA,EAAAI,IAAA,YAAAT,MAAA,CAAAK,GAAA,IAAAjB,GAAA,CAAAiB,GAAA,SAAAL,MAAA,CAAAV,OAAA,GAAAF,GAAA,MAAAS,KAAA,IAAAA,KAAA,CAAAa,GAAA,CAAAtB,GAAA,EAAAY,MAAA,YAAAA,MAAA,IAlBd,uCAEA;AACA;AACA;AACA;AACA;AACA;AACA;AAYA;AACA;AAEA,MAAM,IACAW,QAAQ,EACZ,GAAGC,OAAO,CACX,GAAGC,OAAO,CAACC,IAAI;AAEhB,MAAMC,WAAW,GAAGH,OAAO,CAACI,QAAQ,CAAC,eAAe,CAAC;AAErD,CAAC,YAAY;EACX,IAAI,CAACL,QAAQ,EAAE;IACbM,OAAO,CAACC,KAAK,CAAC,2BAA2B,CAAC;IAE1C;EACF;EAEA,IAAK,QAAQ,CAAEC,IAAI,CAACR,QAAQ,CAAC,EAAE;IAC7BM,OAAO,CAACC,KAAK,CAAC,+CAA+C,CAAC;IAE9D;EACF;EAEA,MAAME,aAAa,GAAG,6BAA6B;EACnD;EACA,MAAMC,SAAS,GAAGC,IAAI,CAACC,KAAK,CAAC,MAAMC,iBAAE,CAACC,QAAQ,CAC5CL,aACF,CAAC,CAAC;EACF,IAAI,CAACC,SAAS,CAACL,QAAQ,CAACL,QAAQ,CAAC,EAAE;IACjCU,SAAS,CAACK,IAAI,CAACf,QAAQ,CAAC;IACxBU,SAAS,CAACM,IAAI,CAAC,CAAC;EAClB;EAEA,MAAMH,iBAAE,CAACI,SAAS,CAACR,aAAa,EAAEE,IAAI,CAACO,SAAS,CAACR,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;EAC5EJ,OAAO,CAACa,GAAG,CAAC,WAAW,EAAET,SAAS,CAAC;EAEnC,MAAMU,YAAY,GAAI;AACxB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,gFAAgFpB,QAAS;AACzF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,CAAC;EAEC,MAAMqB,kBAAkB,GAAG,IAAAC,kBAAS,EAACtB,QAAQ,CAAC;EAE9C,MAAMuB,QAAQ,GAAI,eAAcF,kBAAmB,KAAI;EAEvD,IAAI,CAAC,IAAAG,cAAU,EAACD,QAAQ,CAAC,EAAE;IACzB,MAAMV,iBAAE,CAACI,SAAS,CAACM,QAAQ,EAAEH,YAAY,CAAC;EAC5C;EAEA,MAAMK,gBAAgB,GAAI;AAC5B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,CAAC;EAEC,MAAMC,YAAY,GAAI,2BAA0BL,kBAAmB,KAAI;EACvE,IAAI,CAAC,IAAAG,cAAU,EAACE,YAAY,CAAC,EAAE;IAC7B,MAAMb,iBAAE,CAACI,SAAS,CAACS,YAAY,EAAED,gBAAgB,CAAC;EACpD;EAEA,MAAME,kBAAkB,GAAI,SAAQ3B,QAAS;AAC/C;AACA;AACA;AACA;AACA;AACA,eAAeI,WAAW,GAAG,MAAM,GAAG,OAAQ;AAC9C;AACA;AACA;AACA,kBAAkBiB,kBAAmB;AACrC,CAAC;EAEC,MAAMO,cAAc,GAAI,mBAAkB5B,QAAS,KAAI;EACvD,IAAI,CAAC,IAAAwB,cAAU,EAACI,cAAc,CAAC,EAAE;IAC/B,MAAMf,iBAAE,CAACI,SAAS,CAACW,cAAc,EAAED,kBAAkB,CAAC;EACxD;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAME,cAAc,GAAG,MAAAA,CAAO;IAC5BC,IAAI;IACJC,QAAQ;IACRC,SAAS;IACTC,OAAO;IACPC;EACF,CAAC,KAAK;IACJ;AACJ;AACA;IACI;AACJ;AACA;AACA;AACA;AACA;AACA;IACI;AACJ;AACA;IACI,MAAMC,OAAO,GAAG,EAAE;IAElB,IAAIC,MAAM,GAAG,MAAMvB,iBAAE,CAACC,QAAQ,CAACgB,IAAI,EAAE,MAAM,CAAC;IAC5CM,MAAM,CAACC,OAAO,CACZN,QAAQ;IACR;AACN;AACA;AACA;AACA;AACA;AACA;AACA;AACA;IACM,CAACO,WAAW,EAAEC,EAAE,EAAEC,MAAM,EAAEC,GAAG,EAAE;MAC7BC;IACF,CAAC,KAAK;MACJP,OAAO,CAACpB,IAAI,CAAC;QACXuB,WAAW;QACXE,MAAM;QACNE;MACF,CAAC,CAAC;MAEF,OAAOJ,WAAW;IACpB,CACF,CAAC;IAEDH,OAAO,CAACnB,IAAI,CAAC,CAAC;MACZ0B;IACF,CAAC,EAAE;MACDA,OAAO,EAAEC;IACX,CAAC,KAAK;MACJ,OAAOD,OAAO,GAAGC,QAAQ,GAAG,CAAC,CAAC,GAAID,OAAO,GAAGC,QAAQ,GAAG,CAAC,GAAG,CAAE;IAC/D,CAAC,CAAC;IAEF,IAAIC,eAAe,GAAG,KAAK;IAC3B,MAAMC,SAAS,GAAGV,OAAO,CAACW,SAAS,CAAC,CAAC;MACnCJ;IACF,CAAC,KAAK;MACJE,eAAe,KAAKV,UAAU,GAAGb,kBAAkB,KAAKqB,OAAO,GAAG1C,QAAQ,KAAK0C,OAAO;MAEtF,OAAOR,UAAU,GAAGb,kBAAkB,GAAGqB,OAAO,GAAG1C,QAAQ,GAAG0C,OAAO;IACvE,CAAC,CAAC;IACF,IAAIK,IAAI,GAAGF,SAAS,KAAKG,SAAS,IAAIb,OAAO,CAACU,SAAS,CAAC;IACxD,IAAIE,IAAI,IAAIF,SAAS,KAAK,CAAC;IAEzB;IACAX,UAAU,EACV;MACAa,IAAI,CAACP,MAAM,GAAG,CAAC;IACjB;IAEA,IAAI,CAACO,IAAI,EAAE;MACTA,IAAI,GAAG,yBAA2BZ,OAAO,CAACc,GAAG,CAAC,CAAE;MAChDF,IAAI,CAACP,MAAM,IAAIO,IAAI,CAACT,WAAW,CAACY,MAAM;IACxC;IAEA,IAAIN,eAAe,EAAE;MACnBtC,OAAO,CAACa,GAAG,CAAE,mCAAkCa,SAAU,GAAE,CAAC;IAC9D,CAAC,MAAM;MACLI,MAAM,GAAGA,MAAM,CAACe,KAAK,CAAC,CAAC,EAAEJ,IAAI,CAACP,MAAM,CAAC,IAC1BO,IAAI,CAACP,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC,GACzBP,OAAO,IACNc,IAAI,CAACP,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,GACzBJ,MAAM,CAACe,KAAK,CAACJ,IAAI,CAACP,MAAM,CAAC;MAEnC,MAAM3B,iBAAE,CAACI,SAAS,CAACa,IAAI,EAAEM,MAAM,CAAC;IAClC;EACF,CAAC;;EAED;EACA;EACA;EACA;EACA;EACA;;EAEA,MAAMP,cAAc,CAAC;IACnBG,SAAS,EAAE,cAAc;IACzBC,OAAO,EAAG,UAASZ,kBAAmB,kBAAiBA,kBAAmB,IAAG;IAC7Ea,UAAU,EAAE,IAAI;IAChBH,QAAQ,EAAE,mDAAmD;IAC7DD,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAMD,cAAc,CAAC;IACnBG,SAAS,EAAE,mBAAmB;IAC9BC,OAAO,EAAG,GAAE,GAAG,CAACmB,MAAM,CAAC,CAAC,CAAE,UAASpD,QAAS,MAAKI,WAAW,GAAG,aAAa,GAAG,SAAU,GAAE;IAC3F2B,QAAQ,EAAE,2CAA2C;IACrDD,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAMD,cAAc,CAAC;IACnBG,SAAS,EAAE,aAAa;IACxBC,OAAO,EAAG,GAAE,GAAG,CAACmB,MAAM,CAAC,CAAC,CAAE,IAAGpD,QAAS,MAAKqB,kBAAmB,GAAE;IAChEU,QAAQ,EAAE,sCAAsC;IAChDD,IAAI,EAAE;EACR,CAAC,CAAC;EAEF,MAAAuB,OAAA,CAAAC,OAAA,GAAAC,IAAA,OAAAtE,uBAAA,CAAAb,OAAA,CAAa,mBAAmB,GAAC;;EAEjC;AACF;AACA;AACA;AACA;AACA;;EAEE;EACA8B,OAAO,CAACsD,KAAK,CAAC,IAAAF,aAAO,EAACG,SAAS,EAAE,QAAQ,CAAC,CAAC;EAC3C,MAAM,IAAAC,mBAAI,EAAC;EACT;EACA9B,cAAc,EACdF,YAAY,EACZH,QAAQ,CACT,CAAC;AACJ,CAAC,EAAE,CAAC"}
@@ -1,12 +0,0 @@
1
- declare module 'gitdown' {
2
- interface Gitdown {
3
- setConfig: (info: {
4
- gitinfo: {
5
- defaultBranchName: string,
6
- gitPath: string
7
- }
8
- }) => void
9
- get: () => string
10
- }
11
- export function readFile(path: string): Gitdown
12
- }