forked from public/fvtt-cthulhu-eternal
541 lines
18 KiB
JavaScript
541 lines
18 KiB
JavaScript
"use strict";
|
|
|
|
Object.defineProperty(exports, "__esModule", {
|
|
value: true
|
|
});
|
|
exports.getJsdocProcessorPlugin = void 0;
|
|
var _nodeFs = require("node:fs");
|
|
var _nodePath = require("node:path");
|
|
var _nodeUrl = require("node:url");
|
|
var espree = _interopRequireWildcard(require("espree"));
|
|
var _jsdocUtils = require("./jsdocUtils.cjs");
|
|
var _jsdoccomment = require("@es-joy/jsdoccomment");
|
|
function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
|
|
function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
|
|
// Todo: Support TS by fenced block type
|
|
|
|
const _dirname = (0, _nodePath.dirname)((0, _nodeUrl.fileURLToPath)(require('url').pathToFileURL(__filename).toString()));
|
|
const {
|
|
version
|
|
} = JSON.parse(
|
|
// @ts-expect-error `Buffer` is ok for `JSON.parse`
|
|
(0, _nodeFs.readFileSync)((0, _nodePath.join)(_dirname, '../package.json')));
|
|
|
|
// const zeroBasedLineIndexAdjust = -1;
|
|
const likelyNestedJSDocIndentSpace = 1;
|
|
const preTagSpaceLength = 1;
|
|
|
|
// If a space is present, we should ignore it
|
|
const firstLinePrefixLength = preTagSpaceLength;
|
|
const hasCaptionRegex = /^\s*<caption>([\s\S]*?)<\/caption>/u;
|
|
|
|
/**
|
|
* @param {string} str
|
|
* @returns {string}
|
|
*/
|
|
const escapeStringRegexp = str => {
|
|
return str.replaceAll(/[.*+?^${}()|[\]\\]/gu, '\\$&');
|
|
};
|
|
|
|
/**
|
|
* @param {string} str
|
|
* @param {string} ch
|
|
* @returns {import('./iterateJsdoc.js').Integer}
|
|
*/
|
|
const countChars = (str, ch) => {
|
|
return (str.match(new RegExp(escapeStringRegexp(ch), 'gu')) || []).length;
|
|
};
|
|
|
|
/**
|
|
* @param {string} text
|
|
* @returns {[
|
|
* import('./iterateJsdoc.js').Integer,
|
|
* import('./iterateJsdoc.js').Integer
|
|
* ]}
|
|
*/
|
|
const getLinesCols = text => {
|
|
const matchLines = countChars(text, '\n');
|
|
const colDelta = matchLines ? text.slice(text.lastIndexOf('\n') + 1).length : text.length;
|
|
return [matchLines, colDelta];
|
|
};
|
|
|
|
/**
|
|
* @typedef {number} Integer
|
|
*/
|
|
|
|
/**
|
|
* @typedef {object} JsdocProcessorOptions
|
|
* @property {boolean} [captionRequired]
|
|
* @property {Integer} [paddedIndent]
|
|
* @property {boolean} [checkDefaults]
|
|
* @property {boolean} [checkParams]
|
|
* @property {boolean} [checkExamples]
|
|
* @property {boolean} [checkProperties]
|
|
* @property {string} [matchingFileName]
|
|
* @property {string} [matchingFileNameDefaults]
|
|
* @property {string} [matchingFileNameParams]
|
|
* @property {string} [matchingFileNameProperties]
|
|
* @property {string} [exampleCodeRegex]
|
|
* @property {string} [rejectExampleCodeRegex]
|
|
* @property {"script"|"module"} [sourceType]
|
|
* @property {import('eslint').Linter.FlatConfigParserModule} [parser]
|
|
*/
|
|
|
|
/**
|
|
* We use a function for the ability of the user to pass in a config, but
|
|
* without requiring all users of the plugin to do so.
|
|
* @param {JsdocProcessorOptions} [options]
|
|
*/
|
|
const getJsdocProcessorPlugin = (options = {}) => {
|
|
const {
|
|
exampleCodeRegex = null,
|
|
rejectExampleCodeRegex = null,
|
|
checkExamples = true,
|
|
checkDefaults = false,
|
|
checkParams = false,
|
|
checkProperties = false,
|
|
matchingFileName = null,
|
|
matchingFileNameDefaults = null,
|
|
matchingFileNameParams = null,
|
|
matchingFileNameProperties = null,
|
|
paddedIndent = 0,
|
|
captionRequired = false,
|
|
sourceType = 'module',
|
|
parser = undefined
|
|
} = options;
|
|
|
|
/** @type {RegExp} */
|
|
let exampleCodeRegExp;
|
|
/** @type {RegExp} */
|
|
let rejectExampleCodeRegExp;
|
|
if (exampleCodeRegex) {
|
|
exampleCodeRegExp = (0, _jsdocUtils.getRegexFromString)(exampleCodeRegex);
|
|
}
|
|
if (rejectExampleCodeRegex) {
|
|
rejectExampleCodeRegExp = (0, _jsdocUtils.getRegexFromString)(rejectExampleCodeRegex);
|
|
}
|
|
|
|
/**
|
|
* @type {{
|
|
* targetTagName: string,
|
|
* ext: string,
|
|
* codeStartLine: number,
|
|
* codeStartCol: number,
|
|
* nonJSPrefacingCols: number,
|
|
* commentLineCols: [number, number]
|
|
* }[]}
|
|
*/
|
|
const otherInfo = [];
|
|
|
|
/** @type {import('eslint').Linter.LintMessage[]} */
|
|
let extraMessages = [];
|
|
|
|
/**
|
|
* @param {import('./iterateJsdoc.js').JsdocBlockWithInline} jsdoc
|
|
* @param {string} jsFileName
|
|
* @param {[number, number]} commentLineCols
|
|
*/
|
|
const getTextsAndFileNames = (jsdoc, jsFileName, commentLineCols) => {
|
|
/**
|
|
* @type {{
|
|
* text: string,
|
|
* filename: string|null|undefined
|
|
* }[]}
|
|
*/
|
|
const textsAndFileNames = [];
|
|
|
|
/**
|
|
* @param {{
|
|
* filename: string|null,
|
|
* defaultFileName: string|undefined,
|
|
* source: string,
|
|
* targetTagName: string,
|
|
* rules?: import('eslint').Linter.RulesRecord|undefined,
|
|
* lines?: import('./iterateJsdoc.js').Integer,
|
|
* cols?: import('./iterateJsdoc.js').Integer,
|
|
* skipInit?: boolean,
|
|
* ext: string,
|
|
* sources?: {
|
|
* nonJSPrefacingCols: import('./iterateJsdoc.js').Integer,
|
|
* nonJSPrefacingLines: import('./iterateJsdoc.js').Integer,
|
|
* string: string,
|
|
* }[],
|
|
* tag?: import('comment-parser').Spec & {
|
|
* line?: import('./iterateJsdoc.js').Integer,
|
|
* }|{
|
|
* line: import('./iterateJsdoc.js').Integer,
|
|
* }
|
|
* }} cfg
|
|
*/
|
|
const checkSource = ({
|
|
filename,
|
|
ext,
|
|
defaultFileName,
|
|
lines = 0,
|
|
cols = 0,
|
|
skipInit,
|
|
source,
|
|
targetTagName,
|
|
sources = [],
|
|
tag = {
|
|
line: 0
|
|
}
|
|
}) => {
|
|
if (!skipInit) {
|
|
sources.push({
|
|
nonJSPrefacingCols: cols,
|
|
nonJSPrefacingLines: lines,
|
|
string: source
|
|
});
|
|
}
|
|
|
|
/**
|
|
* @param {{
|
|
* nonJSPrefacingCols: import('./iterateJsdoc.js').Integer,
|
|
* nonJSPrefacingLines: import('./iterateJsdoc.js').Integer,
|
|
* string: string
|
|
* }} cfg
|
|
*/
|
|
const addSourceInfo = function ({
|
|
nonJSPrefacingCols,
|
|
nonJSPrefacingLines,
|
|
string
|
|
}) {
|
|
const src = paddedIndent ? string.replaceAll(new RegExp(`(^|\n) {${paddedIndent}}(?!$)`, 'gu'), '\n') : string;
|
|
|
|
// Programmatic ESLint API: https://eslint.org/docs/developer-guide/nodejs-api
|
|
const file = filename || defaultFileName;
|
|
if (!('line' in tag)) {
|
|
tag.line = tag.source[0].number;
|
|
}
|
|
|
|
// NOTE: `tag.line` can be 0 if of form `/** @tag ... */`
|
|
const codeStartLine =
|
|
/**
|
|
* @type {import('comment-parser').Spec & {
|
|
* line: import('./iterateJsdoc.js').Integer,
|
|
* }}
|
|
*/
|
|
tag.line + nonJSPrefacingLines;
|
|
const codeStartCol = likelyNestedJSDocIndentSpace;
|
|
textsAndFileNames.push({
|
|
text: src,
|
|
filename: file
|
|
});
|
|
otherInfo.push({
|
|
targetTagName,
|
|
ext,
|
|
codeStartLine,
|
|
codeStartCol,
|
|
nonJSPrefacingCols,
|
|
commentLineCols
|
|
});
|
|
};
|
|
for (const targetSource of sources) {
|
|
addSourceInfo(targetSource);
|
|
}
|
|
};
|
|
|
|
/**
|
|
*
|
|
* @param {string|null} filename
|
|
* @param {string} [ext] Since `eslint-plugin-markdown` v2, and
|
|
* ESLint 7, this is the default which other JS-fenced rules will used.
|
|
* Formerly "md" was the default.
|
|
* @returns {{
|
|
* defaultFileName: string|undefined,
|
|
* filename: string|null,
|
|
* ext: string
|
|
* }}
|
|
*/
|
|
const getFilenameInfo = (filename, ext = 'md/*.js') => {
|
|
let defaultFileName;
|
|
if (!filename) {
|
|
if (typeof jsFileName === 'string' && jsFileName.includes('.')) {
|
|
defaultFileName = jsFileName.replace(/\.[^.]*$/u, `.${ext}`);
|
|
} else {
|
|
defaultFileName = `dummy.${ext}`;
|
|
}
|
|
}
|
|
return {
|
|
ext,
|
|
defaultFileName,
|
|
filename
|
|
};
|
|
};
|
|
if (checkDefaults) {
|
|
const filenameInfo = getFilenameInfo(matchingFileNameDefaults, 'jsdoc-defaults');
|
|
(0, _jsdocUtils.forEachPreferredTag)(jsdoc, 'default', (tag, targetTagName) => {
|
|
if (!tag.description.trim()) {
|
|
return;
|
|
}
|
|
checkSource({
|
|
source: `(${(0, _jsdocUtils.getTagDescription)(tag)})`,
|
|
targetTagName,
|
|
...filenameInfo
|
|
});
|
|
});
|
|
}
|
|
if (checkParams) {
|
|
const filenameInfo = getFilenameInfo(matchingFileNameParams, 'jsdoc-params');
|
|
(0, _jsdocUtils.forEachPreferredTag)(jsdoc, 'param', (tag, targetTagName) => {
|
|
if (!tag.default || !tag.default.trim()) {
|
|
return;
|
|
}
|
|
checkSource({
|
|
source: `(${tag.default})`,
|
|
targetTagName,
|
|
...filenameInfo
|
|
});
|
|
});
|
|
}
|
|
if (checkProperties) {
|
|
const filenameInfo = getFilenameInfo(matchingFileNameProperties, 'jsdoc-properties');
|
|
(0, _jsdocUtils.forEachPreferredTag)(jsdoc, 'property', (tag, targetTagName) => {
|
|
if (!tag.default || !tag.default.trim()) {
|
|
return;
|
|
}
|
|
checkSource({
|
|
source: `(${tag.default})`,
|
|
targetTagName,
|
|
...filenameInfo
|
|
});
|
|
});
|
|
}
|
|
if (!checkExamples) {
|
|
return textsAndFileNames;
|
|
}
|
|
const tagName = /** @type {string} */(0, _jsdocUtils.getPreferredTagName)(jsdoc, {
|
|
tagName: 'example'
|
|
});
|
|
if (!(0, _jsdocUtils.hasTag)(jsdoc, tagName)) {
|
|
return textsAndFileNames;
|
|
}
|
|
const matchingFilenameInfo = getFilenameInfo(matchingFileName);
|
|
(0, _jsdocUtils.forEachPreferredTag)(jsdoc, 'example', (tag, targetTagName) => {
|
|
let source = /** @type {string} */(0, _jsdocUtils.getTagDescription)(tag);
|
|
const match = source.match(hasCaptionRegex);
|
|
if (captionRequired && (!match || !match[1].trim())) {
|
|
extraMessages.push({
|
|
line: 1 + commentLineCols[0] + (tag.line ?? tag.source[0].number),
|
|
column: commentLineCols[1] + 1,
|
|
severity: 2,
|
|
message: `@${targetTagName} error - Caption is expected for examples.`,
|
|
ruleId: 'jsdoc/example-missing-caption'
|
|
});
|
|
return;
|
|
}
|
|
source = source.replace(hasCaptionRegex, '');
|
|
const [lines, cols] = match ? getLinesCols(match[0]) : [0, 0];
|
|
if (exampleCodeRegex && !exampleCodeRegExp.test(source) || rejectExampleCodeRegex && rejectExampleCodeRegExp.test(source)) {
|
|
return;
|
|
}
|
|
const sources = [];
|
|
let skipInit = false;
|
|
if (exampleCodeRegex) {
|
|
let nonJSPrefacingCols = 0;
|
|
let nonJSPrefacingLines = 0;
|
|
let startingIndex = 0;
|
|
let lastStringCount = 0;
|
|
let exampleCode;
|
|
exampleCodeRegExp.lastIndex = 0;
|
|
while ((exampleCode = exampleCodeRegExp.exec(source)) !== null) {
|
|
const {
|
|
index,
|
|
'0': n0,
|
|
'1': n1
|
|
} = exampleCode;
|
|
|
|
// Count anything preceding user regex match (can affect line numbering)
|
|
const preMatch = source.slice(startingIndex, index);
|
|
const [preMatchLines, colDelta] = getLinesCols(preMatch);
|
|
let nonJSPreface;
|
|
let nonJSPrefaceLineCount;
|
|
if (n1) {
|
|
const idx = n0.indexOf(n1);
|
|
nonJSPreface = n0.slice(0, idx);
|
|
nonJSPrefaceLineCount = countChars(nonJSPreface, '\n');
|
|
} else {
|
|
nonJSPreface = '';
|
|
nonJSPrefaceLineCount = 0;
|
|
}
|
|
nonJSPrefacingLines += lastStringCount + preMatchLines + nonJSPrefaceLineCount;
|
|
|
|
// Ignore `preMatch` delta if newlines here
|
|
if (nonJSPrefaceLineCount) {
|
|
const charsInLastLine = nonJSPreface.slice(nonJSPreface.lastIndexOf('\n') + 1).length;
|
|
nonJSPrefacingCols += charsInLastLine;
|
|
} else {
|
|
nonJSPrefacingCols += colDelta + nonJSPreface.length;
|
|
}
|
|
const string = n1 || n0;
|
|
sources.push({
|
|
nonJSPrefacingCols,
|
|
nonJSPrefacingLines,
|
|
string
|
|
});
|
|
startingIndex = exampleCodeRegExp.lastIndex;
|
|
lastStringCount = countChars(string, '\n');
|
|
if (!exampleCodeRegExp.global) {
|
|
break;
|
|
}
|
|
}
|
|
skipInit = true;
|
|
}
|
|
checkSource({
|
|
cols,
|
|
lines,
|
|
skipInit,
|
|
source,
|
|
sources,
|
|
tag,
|
|
targetTagName,
|
|
...matchingFilenameInfo
|
|
});
|
|
});
|
|
return textsAndFileNames;
|
|
};
|
|
|
|
// See https://eslint.org/docs/latest/extend/plugins#processors-in-plugins
|
|
// See https://eslint.org/docs/latest/extend/custom-processors
|
|
// From https://github.com/eslint/eslint/issues/14745#issuecomment-869457265
|
|
/*
|
|
{
|
|
"files": ["*.js", "*.ts"],
|
|
"processor": "jsdoc/example" // a pretended value here
|
|
},
|
|
{
|
|
"files": [
|
|
"*.js/*_jsdoc-example.js",
|
|
"*.ts/*_jsdoc-example.js",
|
|
"*.js/*_jsdoc-example.ts"
|
|
],
|
|
"rules": {
|
|
// specific rules for examples in jsdoc only here
|
|
// And other rules for `.js` and `.ts` will also be enabled for them
|
|
}
|
|
}
|
|
*/
|
|
return {
|
|
meta: {
|
|
name: 'eslint-plugin-jsdoc/processor',
|
|
version
|
|
},
|
|
processors: {
|
|
examples: {
|
|
meta: {
|
|
name: 'eslint-plugin-jsdoc/preprocessor',
|
|
version
|
|
},
|
|
/**
|
|
* @param {string} text
|
|
* @param {string} filename
|
|
*/
|
|
preprocess(text, filename) {
|
|
try {
|
|
let ast;
|
|
|
|
// May be running a second time so catch and ignore
|
|
try {
|
|
ast = parser
|
|
// @ts-expect-error Ok
|
|
? parser.parseForESLint(text, {
|
|
ecmaVersion: 'latest',
|
|
sourceType,
|
|
comment: true
|
|
}).ast : espree.parse(text, {
|
|
ecmaVersion: 'latest',
|
|
sourceType,
|
|
comment: true
|
|
});
|
|
} catch (err) {
|
|
return [text];
|
|
}
|
|
|
|
/** @type {[number, number][]} */
|
|
const commentLineCols = [];
|
|
const jsdocComments = /** @type {import('estree').Comment[]} */(
|
|
/**
|
|
* @type {import('estree').Program & {
|
|
* comments?: import('estree').Comment[]
|
|
* }}
|
|
*/
|
|
ast.comments).filter(comment => {
|
|
return /^\*\s/u.test(comment.value);
|
|
}).map(comment => {
|
|
/* c8 ignore next -- Unsupporting processors only? */
|
|
const [start] = comment.range ?? [];
|
|
const textToStart = text.slice(0, start);
|
|
const [lines, cols] = getLinesCols(textToStart);
|
|
|
|
// const lines = [...textToStart.matchAll(/\n/gu)].length
|
|
// const lastLinePos = textToStart.lastIndexOf('\n');
|
|
// const cols = lastLinePos === -1
|
|
// ? 0
|
|
// : textToStart.slice(lastLinePos).length;
|
|
commentLineCols.push([lines, cols]);
|
|
return (0, _jsdoccomment.parseComment)(comment);
|
|
});
|
|
return [text, ...jsdocComments.flatMap((jsdoc, idx) => {
|
|
return getTextsAndFileNames(jsdoc, filename, commentLineCols[idx]);
|
|
}).filter(Boolean)];
|
|
/* c8 ignore next 3 */
|
|
} catch (err) {
|
|
console.log('err', filename, err);
|
|
}
|
|
},
|
|
/**
|
|
* @param {import('eslint').Linter.LintMessage[][]} messages
|
|
* @param {string} filename
|
|
*/
|
|
postprocess([jsMessages, ...messages], filename) {
|
|
messages.forEach((message, idx) => {
|
|
const {
|
|
targetTagName,
|
|
codeStartLine,
|
|
codeStartCol,
|
|
nonJSPrefacingCols,
|
|
commentLineCols
|
|
} = otherInfo[idx];
|
|
message.forEach(msg => {
|
|
const {
|
|
message,
|
|
ruleId,
|
|
severity,
|
|
fatal,
|
|
line,
|
|
column,
|
|
endColumn,
|
|
endLine
|
|
|
|
// Todo: Make fixable
|
|
// fix
|
|
// fix: {range: [number, number], text: string}
|
|
// suggestions: {desc: , messageId:, fix: }[],
|
|
} = msg;
|
|
const [codeCtxLine, codeCtxColumn] = commentLineCols;
|
|
const startLine = codeCtxLine + codeStartLine + line;
|
|
const startCol = 1 +
|
|
// Seems to need one more now
|
|
codeCtxColumn + codeStartCol + (
|
|
// This might not work for line 0, but line 0 is unlikely for examples
|
|
line <= 1 ? nonJSPrefacingCols + firstLinePrefixLength : preTagSpaceLength) + column;
|
|
msg.message = '@' + targetTagName + ' ' + (severity === 2 ? 'error' : 'warning') + (ruleId ? ' (' + ruleId + ')' : '') + ': ' + (fatal ? 'Fatal: ' : '') + message;
|
|
msg.line = startLine;
|
|
msg.column = startCol;
|
|
msg.endLine = endLine ? startLine + endLine : startLine;
|
|
// added `- column` to offset what `endColumn` already seemed to include
|
|
msg.endColumn = endColumn ? startCol - column + endColumn : startCol;
|
|
});
|
|
});
|
|
const ret = [...jsMessages].concat(...messages, ...extraMessages);
|
|
extraMessages = [];
|
|
return ret;
|
|
},
|
|
supportsAutofix: true
|
|
}
|
|
}
|
|
};
|
|
};
|
|
exports.getJsdocProcessorPlugin = getJsdocProcessorPlugin;
|
|
//# sourceMappingURL=getJsdocProcessorPlugin.cjs.map
|