@fyuld/pano 0.1.8 → 0.2.0

package/dist/fitness-tests/unhelpful-errors/index.js

@@ -1,87 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isUnhelpfulErrorsCriterion = exports.runUnhelpfulErrors = void 0;
-const fs = __importStar(require("fs"));
-const path = __importStar(require("path"));
-const format_1 = require("../../format");
-const pano_dm_1 = require("@fyuld/pano-dm");
-const BANNED_CLASSES = new Set(['Error']);
-const isInExemptedDirectory = (filePath, dirs) => {
-    const normalized = filePath.split(path.sep).join('/');
-    return dirs.some((d) => {
-        const dn = d.replace(/^\.\//, '').replace(/\/$/, '');
-        return normalized === dn || normalized.startsWith(`${dn}/`);
-    });
-};
-const isUnhelpful = (t) => t.kind === 'new' &&
-    t.className !== undefined &&
-    BANNED_CLASSES.has(t.className);
-const interpolate = (template, vars) => template.replace(/\{\{(\w+)\}\}/g, (_, key) => vars[key] ?? `{{${key}}}`);
-const render = (criterion, violations, totalThrows, proportionalScore, objectiveMarkdown) => {
-    const detailsRendered = interpolate(criterion.details, {});
-    const lines = [];
-    lines.push((0, format_1.styled)('30;47', criterion.title));
-    lines.push(detailsRendered);
-    if (objectiveMarkdown) {
-        lines.push('');
-        lines.push(objectiveMarkdown.trimEnd());
-    }
-    lines.push('');
-    lines.push(`Found ${violations.length} unhelpful throw${violations.length === 1 ? '' : 's'} (of ${totalThrows} total):`);
-    for (const v of violations) {
-        lines.push(`  - new ${v.className}(...) at ${v.file}:${v.line}`);
-    }
-    lines.push('');
-    lines.push(`Absolute Score: ${violations.length}`);
-    lines.push(`Proportional Score: ${(proportionalScore * 100).toFixed(2)}%`);
-    return lines.join('\n');
-};
-const runUnhelpfulErrors = (criterion, throwsJson, objectiveMarkdown) => {
-    const report = JSON.parse(fs.readFileSync(throwsJson, 'utf-8'));
-    const violations = report.throws.filter((t) => isUnhelpful(t) &&
-        !isInExemptedDirectory(t.file, criterion.exemptedDirectories));
-    const proportionalScore = report.totalThrows === 0 ? 0 : violations.length / report.totalThrows;
-    return {
-        absoluteScore: violations.length,
-        proportionalScore,
-        rendered: render(criterion, violations, report.totalThrows, proportionalScore, objectiveMarkdown),
-        violations,
-    };
-};
-exports.runUnhelpfulErrors = runUnhelpfulErrors;
-const isUnhelpfulErrorsCriterion = (c) => c.kind === pano_dm_1.CriterionKind.UnhelpfulErrors;
-exports.isUnhelpfulErrorsCriterion = isUnhelpfulErrorsCriterion;
-//# sourceMappingURL=index.js.map

package/dist/fitness-tests/unhelpful-errors/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/fitness-tests/unhelpful-errors/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAwB;AACxB,2CAA4B;AAE5B,yCAAqC;AACrC,4CAIuB;AAEvB,MAAM,cAAc,GAAG,IAAI,GAAG,CAAS,CAAC,OAAO,CAAC,CAAC,CAAA;AASjD,MAAM,qBAAqB,GAAG,CAAC,QAAgB,EAAE,IAAc,EAAW,EAAE;IAC1E,MAAM,UAAU,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACrD,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;QACrB,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACpD,OAAO,UAAU,KAAK,EAAE,IAAI,UAAU,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;IAC7D,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AAED,MAAM,WAAW,GAAG,CAAC,CAAa,EAAW,EAAE,CAC7C,CAAC,CAAC,IAAI,KAAK,KAAK;IAChB,CAAC,CAAC,SAAS,KAAK,SAAS;IACzB,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;AAEjC,MAAM,WAAW,GAAG,CAAC,QAAgB,EAAE,IAA4B,EAAU,EAAE,CAC7E,QAAQ,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,GAAG,IAAI,CAAC,CAAA;AAE3E,MAAM,MAAM,GAAG,CACb,SAAmC,EACnC,UAAwB,EACxB,WAAmB,EACnB,iBAAyB,EACzB,iBAA0B,EAClB,EAAE;IACV,MAAM,eAAe,GAAG,WAAW,CAAC,SAAS,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;IAC1D,MAAM,KAAK,GAAa,EAAE,CAAA;IAC1B,KAAK,CAAC,IAAI,CAAC,IAAA,eAAM,EAAC,OAAO,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,CAAA;IAC5C,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;IAC3B,IAAI,iBAAiB,EAAE,CAAC;QACtB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACd,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,CAAC,CAAA;IACzC,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IACd,KAAK,CAAC,IAAI,CACR,SAAS,UAAU,CAAC,MAAM,mBAAmB,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,QAAQ,WAAW,UAAU,CAC7G,CAAA;IACD,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,SAAS,YAAY,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;IAClE,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IACd,KAAK,CAAC,IAAI,CAAC,mBAAmB,UAAU,CAAC,MAAM,EAAE,CAAC,CAAA;IAClD,KAAK,CAAC,IAAI,CAAC,uBAAuB,CAAC,iBAAiB,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;IAC1E,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACzB,CAAC,CAAA;AAEM,MAAM,kBAAkB,GAAG,CAChC,SAAmC,EACnC,UAAkB,EAClB,iBAA0B,EACH,EAAE;IACzB,MAAM,MAAM,GAAiB,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAA;IAC7E,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CACrC,CAAC,CAAC,EAAE,EAAE,CACJ,WAAW,CAAC,CAAC,CAAC;QACd,CAAC,qBAAqB,CAAC,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,mBAAmB,CAAC,CAChE,CAAA;IACD,MAAM,iBAAiB,GACrB,MAAM,CAAC,WAAW,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC,WAAW,CAAA;IACvE,OAAO;QACL,aAAa,EAAE,UAAU,CAAC,MAAM;QAChC,iBAAiB;QACjB,QAAQ,EAAE,MAAM,CACd,SAAS,EACT,UAAU,EACV,MAAM,CAAC,WAAW,EAClB,iBAAiB,EACjB,iBAAiB,CAClB;QACD,UAAU;KACX,CAAA;AACH,CAAC,CAAA;AAzBY,QAAA,kBAAkB,sBAyB9B;AAEM,MAAM,0BAA0B,GAAG,CACxC,CAAY,EACmB,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,uBAAa,CAAC,eAAe,CAAA;AAF/D,QAAA,0BAA0B,8BAEqC"}

package/dist/languages/typescript/comment-classification.d.ts

@@ -1,8 +0,0 @@
-import { CommentKind } from '@fyuld/pano-dm';
-import { Comment } from './comments';
-export type ClassifiedComment = Comment & {
-    category: CommentKind;
-};
-export declare const classifyComment: (c: Comment) => CommentKind;
-export declare const classifyComments: (comments: Comment[]) => ClassifiedComment[];
-//# sourceMappingURL=comment-classification.d.ts.map

package/dist/languages/typescript/comment-classification.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"comment-classification.d.ts","sourceRoot":"","sources":["../../../src/languages/typescript/comment-classification.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEpC,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG;IAAE,QAAQ,EAAE,WAAW,CAAA;CAAE,CAAA;AAwBnE,eAAO,MAAM,eAAe,GAAI,GAAG,OAAO,KAAG,WAc5C,CAAA;AAED,eAAO,MAAM,gBAAgB,GAAI,UAAU,OAAO,EAAE,KAAG,iBAAiB,EACT,CAAA"}

package/dist/languages/typescript/comment-classification.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.classifyComments = exports.classifyComment = void 0;
-const innerText = (c) => {
-    if (c.kind === 'SingleLine') {
-        return c.text.replace(/^\/\/\s*/, '').trim();
-    }
-    return c.text
-        .replace(/^\/\*+\s*/, '')
-        .replace(/\s*\*+\/$/, '')
-        .trim();
-};
-const TODO_KEYWORD = /^(TODO|XXX)\b/i;
-const FIXME_KEYWORD = /^FIXME\b/i;
-const HACK_KEYWORD = /^HACK\b/i;
-const EXPLANATION_KEYWORD = /^EXPLANATION:/i;
-const TOGGLE_TAG = /^(eslint-disable-(next-line|line)|prettier-ignore|@ts-(ignore|expect-error)\b)/;
-const IGNORE_TAG = /^(eslint-disable(?!-next-line|-line)|@ts-nocheck\b)/;
-const JSDOC_OPEN = /^\/\*\*/;
-// 'Legal' is reserved in the enum but not yet detected here.
-// Intended definition: a /** */ block containing 'Copyright' and/or 'SPDX' somewhere inside.
-const classifyComment = (c) => {
-    const inner = innerText(c);
-    if (TODO_KEYWORD.test(inner))
-        return 'Todo';
-    if (FIXME_KEYWORD.test(inner))
-        return 'Fixme';
-    if (HACK_KEYWORD.test(inner))
-        return 'Hack';
-    if (EXPLANATION_KEYWORD.test(inner))
-        return 'Explanation';
-    if (TOGGLE_TAG.test(inner))
-        return 'ToggleDevFeature';
-    if (IGNORE_TAG.test(inner))
-        return 'IgnoreDevFeature';
-    if (c.kind === 'MultiLine' && JSDOC_OPEN.test(c.text))
-        return 'Documentation';
-    return c.kind === 'SingleLine'
-        ? 'PlainSinglelineComment'
-        : 'PlainMultilineComment';
-};
-exports.classifyComment = classifyComment;
-const classifyComments = (comments) => comments.map((c) => ({ ...c, category: (0, exports.classifyComment)(c) }));
-exports.classifyComments = classifyComments;
-//# sourceMappingURL=comment-classification.js.map

package/dist/languages/typescript/comment-classification.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"comment-classification.js","sourceRoot":"","sources":["../../../src/languages/typescript/comment-classification.ts"],"names":[],"mappings":";;;AAKA,MAAM,SAAS,GAAG,CAAC,CAAU,EAAU,EAAE;IACvC,IAAI,CAAC,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QAC5B,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAA;IAC9C,CAAC;IACD,OAAO,CAAC,CAAC,IAAI;SACV,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;SACxB,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;SACxB,IAAI,EAAE,CAAA;AACX,CAAC,CAAA;AAED,MAAM,YAAY,GAAG,gBAAgB,CAAA;AACrC,MAAM,aAAa,GAAG,WAAW,CAAA;AACjC,MAAM,YAAY,GAAG,UAAU,CAAA;AAC/B,MAAM,mBAAmB,GAAG,gBAAgB,CAAA;AAC5C,MAAM,UAAU,GACd,gFAAgF,CAAA;AAClF,MAAM,UAAU,GAAG,qDAAqD,CAAA;AACxE,MAAM,UAAU,GAAG,SAAS,CAAA;AAE5B,6DAA6D;AAC7D,6FAA6F;AAEtF,MAAM,eAAe,GAAG,CAAC,CAAU,EAAe,EAAE;IACzD,MAAM,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;IAE1B,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,MAAM,CAAA;IAC3C,IAAI,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,OAAO,CAAA;IAC7C,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,MAAM,CAAA;IAC3C,IAAI,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,aAAa,CAAA;IACzD,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,kBAAkB,CAAA;IACrD,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,kBAAkB,CAAA;IACrD,IAAI,CAAC,CAAC,IAAI,KAAK,WAAW,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;QAAE,OAAO,eAAe,CAAA;IAE7E,OAAO,CAAC,CAAC,IAAI,KAAK,YAAY;QAC5B,CAAC,CAAC,wBAAwB;QAC1B,CAAC,CAAC,uBAAuB,CAAA;AAC7B,CAAC,CAAA;AAdY,QAAA,eAAe,mBAc3B;AAEM,MAAM,gBAAgB,GAAG,CAAC,QAAmB,EAAuB,EAAE,CAC3E,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,QAAQ,EAAE,IAAA,uBAAe,EAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AADlD,QAAA,gBAAgB,oBACkC"}

package/dist/languages/typescript/index.d.ts

@@ -1,4 +0,0 @@
-export * from './parser';
-export * from './comments';
-export * from './comment-classification';
-//# sourceMappingURL=index.d.ts.map

package/dist/languages/typescript/parser.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"parser.js","sourceRoot":"","sources":["../../../src/languages/typescript/parser.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAgC;AAEhC,MAAM,eAAe,GAAG,CAAC,QAAgB,EAAiB,EAAE;IAC1D,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;QAAE,OAAO,EAAE,CAAC,UAAU,CAAC,GAAG,CAAA;IACvD,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;QAAE,OAAO,EAAE,CAAC,UAAU,CAAC,GAAG,CAAA;IACvD,IAAI,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC,UAAU,CAAC,EAAE,CAAA;IACrD,OAAO,EAAE,CAAC,UAAU,CAAC,EAAE,CAAA;AACzB,CAAC,CAAA;AAEM,MAAM,eAAe,GAAG,CAC7B,MAAc,EACd,QAAQ,GAAG,UAAU,EACN,EAAE,CACjB,EAAE,CAAC,gBAAgB,CACjB,QAAQ,EACR,MAAM,EACN,EAAE,CAAC,YAAY,CAAC,MAAM,EACtB,IAAI,EACJ,eAAe,CAAC,QAAQ,CAAC,CAC1B,CAAA;AAVU,QAAA,eAAe,mBAUzB;AAEI,MAAM,kBAAkB,GAAG,CAChC,UAAyB,EACC,EAAE,CAC3B,UAAgE;KAC9D,gBAAgB,IAAI,EAAE,CAAA;AAJd,QAAA,kBAAkB,sBAIJ"}