@angular-eslint/eslint-plugin
Version:
ESLint plugin for Angular applications, following https://angular.dev/style-guide
46 lines (45 loc) • 1.97 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.RULE_DOCS_EXTENSION = exports.RULE_NAME = void 0;
const create_eslint_rule_1 = require("../utils/create-eslint-rule");
const eslint_utils_1 = require("@typescript-eslint/utils/eslint-utils");
const jsdoc_1 = require("../utils/jsdoc");
exports.RULE_NAME = 'no-developer-preview';
exports.default = (0, create_eslint_rule_1.createESLintRule)({
name: exports.RULE_NAME,
meta: {
type: 'problem',
docs: {
description: `Disallow using code which is marked as developer preview`,
},
schema: [],
messages: {
noDeveloperPreview: '`{{name}}` is in developer preview',
},
},
defaultOptions: [],
create(context) {
const services = (0, eslint_utils_1.getParserServices)(context);
const checker = services.program.getTypeChecker();
return {
Identifier: (node) => {
if ((0, jsdoc_1.isDeclaration)(node) || (0, jsdoc_1.isInsideExportOrImport)(node)) {
return;
}
const symbols = (0, jsdoc_1.getSymbols)(node, services, checker);
if (!(0, jsdoc_1.hasJsDocTag)(symbols, 'developerPreview')) {
return;
}
const { name } = node;
context.report({
node,
messageId: 'noDeveloperPreview',
data: { name },
});
},
};
},
});
exports.RULE_DOCS_EXTENSION = {
rationale: `Angular's [developer preview APIs](https://angular.dev/reference/releases#developer-preview) are fully functional and polished, but not yet covered by Angular's [breaking change policy](https://angular.dev/reference/releases#breaking-change-policy-and-update-paths). These APIs may change even in patch releases, making them risky for production applications.`,
};