markuplint 3.0.0-rc.5 → 3.0.0

package/lib/api/ml-engine.js

@@ -10,6 +10,7 @@ const debug_1 = require("../debug");
 const i18n_1 = require("../i18n");
 const log = debug_1.log.extend('ml-engine');
 const fileLog = log.extend('file');
+const configLog = log.extend('config');
 class MLEngine extends strict_event_emitter_1.StrictEventEmitter {
     static async toMLFile(target) {
         const files = await (0, file_resolver_1.resolveFiles)([target]);
@@ -211,13 +212,25 @@ class MLEngine extends strict_event_emitter_1.StrictEventEmitter {
     async resolveConfig(cache) {
         var _a, _b, _c, _d, _e, _f;
         const defaultConfigKey = ((_a = tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f")) === null || _a === void 0 ? void 0 : _a.defaultConfig) && tslib_1.__classPrivateFieldGet(this, _MLEngine_configProvider, "f").set((_b = tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f")) === null || _b === void 0 ? void 0 : _b.defaultConfig);
+        configLog('defaultConfigKey: %s', defaultConfigKey !== null && defaultConfigKey !== void 0 ? defaultConfigKey : 'N/A');
+        this.emit('log', 'defaultConfigKey', defaultConfigKey !== null && defaultConfigKey !== void 0 ? defaultConfigKey : 'N/A');
         const configFilePathsFromTarget = ((_c = tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f")) === null || _c === void 0 ? void 0 : _c.noSearchConfig)
             ? defaultConfigKey !== null && defaultConfigKey !== void 0 ? defaultConfigKey : null
             : (await tslib_1.__classPrivateFieldGet(this, _MLEngine_configProvider, "f").search(tslib_1.__classPrivateFieldGet(this, _MLEngine_file, "f"))) || defaultConfigKey;
-        this.emit('log', 'configFilePathsFromTarget', configFilePathsFromTarget || 'null');
+        configLog('configFilePathsFromTarget: %s', configFilePathsFromTarget !== null && configFilePathsFromTarget !== void 0 ? configFilePathsFromTarget : 'N/A');
+        this.emit('log', 'configFilePathsFromTarget', configFilePathsFromTarget !== null && configFilePathsFromTarget !== void 0 ? configFilePathsFromTarget : 'N/A');
         const configKey = ((_d = tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f")) === null || _d === void 0 ? void 0 : _d.config) && tslib_1.__classPrivateFieldGet(this, _MLEngine_configProvider, "f").set(tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f").config);
-        this.emit('log', 'configKey', configKey || 'null');
-        const configSet = await tslib_1.__classPrivateFieldGet(this, _MLEngine_configProvider, "f").resolve(tslib_1.__classPrivateFieldGet(this, _MLEngine_file, "f"), [configFilePathsFromTarget, (_e = tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f")) === null || _e === void 0 ? void 0 : _e.configFile, configKey], cache);
+        configLog('option.config: %s', configKey !== null && configKey !== void 0 ? configKey : 'N/A');
+        this.emit('log', 'option.config', configFilePathsFromTarget !== null && configFilePathsFromTarget !== void 0 ? configFilePathsFromTarget : 'N/A');
+        let defaultRecommended = null;
+        if (!defaultConfigKey && !configFilePathsFromTarget && !configKey) {
+            // No configured
+            // Default: set recommended
+            defaultRecommended = tslib_1.__classPrivateFieldGet(this, _MLEngine_configProvider, "f").set({ extends: ['markuplint:recommended'] });
+        }
+        configLog('defaultRecommended: %s', defaultRecommended !== null && defaultRecommended !== void 0 ? defaultRecommended : 'N/A');
+        this.emit('log', 'defaultRecommended', defaultRecommended !== null && defaultRecommended !== void 0 ? defaultRecommended : 'N/A');
+        const configSet = await tslib_1.__classPrivateFieldGet(this, _MLEngine_configProvider, "f").resolve(tslib_1.__classPrivateFieldGet(this, _MLEngine_file, "f"), [configFilePathsFromTarget, (_e = tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f")) === null || _e === void 0 ? void 0 : _e.configFile, configKey, defaultRecommended], cache);
         this.emit('config', tslib_1.__classPrivateFieldGet(this, _MLEngine_file, "f").path, configSet);
         if ((_f = tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f")) === null || _f === void 0 ? void 0 : _f.watch) {
             // It doesn't watch the main HTML file because it may is watched and managed by a language server or text editor or more.

package/lib/cli/create-rule/index.js

@@ -2,12 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createRule = void 0;
 const tslib_1 = require("tslib");
+const node_path_1 = require("node:path");
 const create_rule_helper_1 = require("@markuplint/create-rule-helper");
 const cli_color_1 = tslib_1.__importDefault(require("cli-color"));
 const util_1 = require("../../util");
 const install_module_1 = require("../init/install-module");
 const prompt_1 = require("../prompt");
+const icons = {
+    README: '📝',
+    index: '📜',
+    schema: '⚙️ ',
+    package: '🎁',
+    tsconfig: '💎',
+};
 async function createRule() {
+    var _a;
     (0, util_1.write)((0, util_1.head)('Create a rule'));
     util_1.write.break();
     const firstChoices = [
@@ -21,7 +30,31 @@ async function createRule() {
         message: 'What purpose do you create the rule for?',
         choices: firstChoices,
     });
-    const name = await (0, prompt_1.input)('What is the name?', /^[a-z][a-z0-9]*(?:-[a-z][a-z0-9]*)*$/i);
+    const dirQuestion = purpose === 'ADD_TO_PROJECT' ? 'What is the directory name?' : 'What is the plugin name?';
+    const pluginName = purpose === 'CONTRIBUTE_TO_CORE' ? '' : await (0, prompt_1.input)(dirQuestion, /^[a-z][a-z0-9]*(?:-[a-z][a-z0-9]*)*$/i);
+    const ruleName = await (0, prompt_1.input)('What is the rule name?', /^[a-z][a-z0-9]*(?:-[a-z][a-z0-9]*)*$/i);
+    const core = purpose === 'CONTRIBUTE_TO_CORE'
+        ? {
+            description: await (0, prompt_1.input)('Description:'),
+            category: await (0, prompt_1.select)({
+                message: 'Category:',
+                choices: [
+                    { name: 'Conformance checking', value: 'validation' },
+                    { name: 'Accessibility', value: 'a11y' },
+                    { name: 'Naming Convention', value: 'naming-convention' },
+                    { name: 'Maintainability', value: 'maintainability' },
+                    { name: 'Style', value: 'style' },
+                ],
+            }),
+            severity: await (0, prompt_1.select)({
+                message: 'Severity:',
+                choices: [
+                    { name: 'error', value: 'error' },
+                    { name: 'warning', value: 'warning' },
+                ],
+            }),
+        }
+        : undefined;
     const lang = purpose === 'CONTRIBUTE_TO_CORE'
         ? 'TYPESCRIPT'
         : await (0, prompt_1.select)({
@@ -32,27 +65,14 @@ async function createRule() {
             ],
         });
     const needTest = purpose === 'CONTRIBUTE_TO_CORE' ? true : await (0, prompt_1.confirm)('Do you need the test?', { initial: true });
-    const result = await (0, create_rule_helper_1.createRuleHelper)({ purpose, name, lang, needTest });
-    output(name, '📝', 'README.md', result.readme);
-    output(name, '📜', 'index', result.main);
-    if (result.test) {
-        output(name, '🖍 ', 'index.spec', result.test);
-    }
-    if (result.rules) {
-        output(name, '🛡 ', 'rules', result.rules);
-    }
-    if (result.rulesTest) {
-        output(name, '🖍 ', 'rules.spec', result.rulesTest);
+    const result = await (0, create_rule_helper_1.createRuleHelper)({ purpose, pluginName, ruleName, lang, needTest, core });
+    for (const file of result.files) {
+        output(pluginName || 'core', file.test ? '🖍 ' : (_a = icons[file.name]) !== null && _a !== void 0 ? _a : '🛡 ', file.fileName, (0, node_path_1.resolve)(file.destDir, file.fileName + file.ext));
     }
-    if (result.schemaJson) {
-        output(name, '⚙️ ', 'schema.json', result.schemaJson);
-    }
-    if (result.packageJson) {
-        output(name, '🎁', 'package.json', result.packageJson);
-        if (result.tsConfig) {
-            output(name, '💎', 'tsconfig.json', result.tsConfig);
-        }
+    if (result.dependencies.length) {
         await (0, install_module_1.installModule)(result.dependencies);
+    }
+    if (result.devDependencies.length) {
         await (0, install_module_1.installModule)(result.devDependencies, true);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "markuplint",
-	"version": "3.0.0-rc.5",
+	"version": "3.0.0",
 	"description": "A linter for all markup developers",
 	"author": "Yusuke Hirao",
 	"license": "MIT",
@@ -25,16 +25,16 @@
 		"execa": "5"
 	},
 	"dependencies": {
-		"@markuplint/create-rule-helper": "3.0.0-rc.5",
-		"@markuplint/file-resolver": "3.0.0-rc.5",
-		"@markuplint/html-parser": "3.0.0-rc.5",
-		"@markuplint/html-spec": "3.0.0-rc.5",
+		"@markuplint/create-rule-helper": "3.0.0",
+		"@markuplint/file-resolver": "3.0.0",
+		"@markuplint/html-parser": "3.0.0",
+		"@markuplint/html-spec": "3.0.0",
 		"@markuplint/i18n": "3.0.0-rc.5",
 		"@markuplint/ml-ast": "3.0.0-rc.5",
-		"@markuplint/ml-config": "3.0.0-rc.5",
-		"@markuplint/ml-core": "3.0.0-rc.5",
-		"@markuplint/ml-spec": "3.0.0-rc.5",
-		"@markuplint/rules": "3.0.0-rc.5",
+		"@markuplint/ml-config": "3.0.0",
+		"@markuplint/ml-core": "3.0.0",
+		"@markuplint/ml-spec": "3.0.0",
+		"@markuplint/rules": "3.0.0",
 		"chokidar": "^3.5.3",
 		"cli-color": "^2.0.3",
 		"debug": "^4.3.4",
@@ -50,5 +50,5 @@
 		"tslib": "^2.4.1",
 		"uuid": "^9.0.0"
 	},
-	"gitHead": "fb0cde3550b1c9df1279da8019146f9a495216e7"
+	"gitHead": "51af6a64bb8da54376a138f19e3f15a2f759a967"
 }