markuplint 2.0.0-rc.2 → 2.0.0

package/README.md

@@ -1,26 +1,65 @@
 # ![markuplint](https://cdn.rawgit.com/YusukeHirao/markuplint/HEAD/media/logo-v.svg)
 
 [![npm version](https://badge.fury.io/js/markuplint.svg)](https://badge.fury.io/js/markuplint)
-[![Build Status](https://travis-ci.org/markuplint/markuplint.svg?branch=main)](https://travis-ci.org/markuplint/markuplint) [![Coverage Status](https://coveralls.io/repos/github/markuplint/markuplint/badge.svg?branch=main)](https://coveralls.io/github/markuplint/markuplint?branch=main)
+[![Test](https://github.com/markuplint/markuplint/workflows/Test/badge.svg?branch=main)](https://github.com/markuplint/markuplint/actions?query=workflow%3ATest)
+[![Coverage Status](https://coveralls.io/repos/github/markuplint/markuplint/badge.svg?branch=main)](https://coveralls.io/github/markuplint/markuplint?branch=main)
 
-A Linter for All Markup Languages (for legacy/modern HTML, Web Components, SVG, MathML, AMP HTML and more).
+Peace of mind in your markup - A Linter for All Markup Languages.
 
-## Install
+## Features
+
+- Conformance checking that according to HTML Living Standard, WAI-ARIA, and ARIA in HTML.
+- Supports SVG and CSS Values.
+- Supports React, Vue, Svelte, Pug, PHP, and more.
+- Possible to specify the rule to each element if you use the selector.
+- Possible to create a custom rule.
+
+![Screenshot: Violation Report CLI output](https://raw.githubusercontent.com/markuplint/markuplint/main/packages/markuplint/media/screenshot01.png)
+
+## Instant using
 
 ```
-$ npm install -D markuplint
-$ yarn add -D markuplint
+$ npx markuplint target.html
 ```
 
 Supported for _Node.js_ `v12.4.0` or later.
 
 ## Usage
 
-### CLI
+### Initialization
+
+Create a [configuration](https://markuplint.dev/configuration) file and install dependencies.
+
+```
+$ npx markuplint --init
+# or
+$ yarn run markuplint --init
+```
+
+Answer questions interactively.
+By doing this, needed modules are installed includes `markuplint`.
+
+Add a command to the `scripts` option on `package.json`:
 
+```json
+{
+  "scripts": {
+    "html:lint": "markuplint **/*.html"
+  }
+}
 ```
-$ npx markuplint verifyee.html
+
+If you want to change the target path, you can change it for your project.
+
+Execute the script:
+
 ```
+$ npm run html:lint
+# or
+$ yarn html:lint
+```
+
+### Command line options
 
 ```
 $ npx markuplint --help
@@ -30,42 +69,60 @@ Usage
 	$ <stdout> | markuplint
 
 Options
-	--config-file,  -c FILE_PATH  Ruleset file path.
-	--fix,                        Fix HTML.
-	--format,       -f FORMAT     Output format. Support "JSON", "Simple" and "Standard". Default: "Standard".
-	--no-color,                   Output no color.
-	--problem-only, -p            Output only problems, without passeds.
-	--verbose                     Output with detailed information.
-
-	--help,         -h            Show help.
-	--version,      -v            Show version.
+	--config,                -c FILE_PATH  A configuration file path.
+	--fix,                                 Fix HTML.
+	--format,                -f FORMAT     Output format. Support "JSON", "Simple" and "Standard". Default: "Standard".
+	--no-search-config                     No search a configure file automatically.
+	--ignore-ext                           Evaluate files that are received even though the type of extension.
+	--no-import-preset-rules               No import preset rules.
+	--locale                               Locale of the message of violation. Default is an OS setting.
+	--no-color,                            Output no color.
+	--problem-only,          -p            Output only problems, without passeds.
+	--verbose                              Output with detailed information.
+
+	--init                                 Initialize settings interactively.
+	--create-rule                          Add the scaffold of a custom rule.
+
+	--help,                  -h            Show help.
+	--version,               -v            Show version.
 
 Examples
-	$ markuplint verifyee.html --ruleset path/to/.markuplintrc
+	$ markuplint verifyee.html --config path/to/.markuplintrc
 	$ cat verifyee.html | markuplint
 ```
 
-![Screen shot](media/screenshot01.png)
+## Guideline
+
+- [Getting Started](https://markuplint.dev/getting-started)
+- [Rules](https://markuplint.dev/rules)
+- [Configuration](https://markuplint.dev/configuration)
+- [API](https://markuplint.dev/api-docs)
+- [Playground](https://playground.markuplint.dev/)
+
+## Editor Extensions
+
+| Editor                                                                                                                                                                                                                                                          | Installation Page                                                                                       | Author                                         |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
+| <a href="https://marketplace.visualstudio.com/items?itemName=yusukehirao.vscode-markuplint"><img src="https://raw.githubusercontent.com/markuplint/markuplint/main/media/vscode.png" width="75" height="82" alt="Visual Studio Code: markuplint extension"></a> | [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=yusukehirao.vscode-markuplint) | [@YusukeHirao](https://github.com/YusukeHirao) |
 
-### API
+## License
 
--   [Functions](https://markuplint.dev/api-docs#Functions)
--   [Interface Document](https://api.markuplint.dev) (genereated by [TypeDoc](https://typedoc.org/))
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmarkuplint%2Fmarkuplint.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmarkuplint%2Fmarkuplint?ref=badge_large)
 
-## Configuration
+## Sponsors
 
--   [Configuration](https://markuplint.dev/configuration)
+[:heart: Sponsor](https://github.com/sponsors/markuplint)
 
-## Rules
+### Personal Supporters
 
--   [Rules](https://markuplint.dev/rules)
--   Customizing your rule **🚧 WIP**
+[<img width="36" src="https://avatars.githubusercontent.com/u/6581173?v=4" alt="mikimhk"/>](https://github.com/mikimhk)
+[<img width="36" src="https://avatars.githubusercontent.com/u/91733847?v=4" alt="Tokitake" />](https://github.com/Tokitake)
 
 ## Thanks
 
 This linter is inspired by:
 
--   [HTMLHint](http://htmlhint.com/)
--   [ESLint](https://eslint.org/)
--   [stylelint](https://stylelint.io/)
--   [textlint](https://textlint.github.io/)
+- [HTMLHint](http://htmlhint.com/)
+- [ESLint](https://eslint.org/)
+- [stylelint](https://stylelint.io/)
+- [textlint](https://textlint.github.io/)

package/lib/api/ml-engine.d.ts

@@ -3,25 +3,25 @@ import type { APIOptions, MLEngineEventMap } from './types';
 import type { MLFile, Target } from '@markuplint/file-resolver';
 import { StrictEventEmitter } from 'strict-event-emitter';
 declare type MLEngineOptions = {
-    debug?: boolean;
-    watch?: boolean;
+	debug?: boolean;
+	watch?: boolean;
 };
 export default class MLEngine extends StrictEventEmitter<MLEngineEventMap> {
-    #private;
-    static toMLFile(target: Target): Promise<MLFile>;
-    constructor(file: MLFile, options?: APIOptions & MLEngineOptions);
-    exec(): Promise<MLResultInfo | null>;
-    setCode(code: string): Promise<void>;
-    close(): Promise<void>;
-    private setup;
-    private provide;
-    private cretateCore;
-    private resolveConfig;
-    private resolveParser;
-    private resolveRuleset;
-    private resolveSchemas;
-    private resolveRules;
-    private i18n;
-    private watch;
+	#private;
+	static toMLFile(target: Target): Promise<MLFile>;
+	constructor(file: MLFile, options?: APIOptions & MLEngineOptions);
+	exec(): Promise<MLResultInfo | null>;
+	setCode(code: string): Promise<void>;
+	close(): Promise<void>;
+	private setup;
+	private provide;
+	private cretateCore;
+	private resolveConfig;
+	private resolveParser;
+	private resolveRuleset;
+	private resolveSchemas;
+	private resolveRules;
+	private i18n;
+	private watch;
 }
 export {};

package/lib/api/ml-engine.js

@@ -113,6 +113,10 @@ class MLEngine extends strict_event_emitter_1.StrictEventEmitter {
         fileLog('Resolved Config: %O', configSet.config);
         fileLog('Resolved Plugins: %O', configSet.plugins);
         fileLog('Resolve Errors: %O', configSet.errs);
+        if (!(await (0, tslib_1.__classPrivateFieldGet)(this, _MLEngine_file, "f").isFile())) {
+            this.emit('log', 'file-no-exists', `The file doesn't exist or it is not a file: ${(0, tslib_1.__classPrivateFieldGet)(this, _MLEngine_file, "f").path}`);
+            return null;
+        }
         // Exclude
         const excludeFiles = configSet.config.excludeFiles || [];
         for (const excludeFile of excludeFiles) {
@@ -122,9 +126,9 @@ class MLEngine extends strict_event_emitter_1.StrictEventEmitter {
             }
         }
         const { parser, parserOptions, matched } = await this.resolveParser(configSet);
-        // Ext Matching
-        if (((_a = (0, tslib_1.__classPrivateFieldGet)(this, _MLEngine_options, "f")) === null || _a === void 0 ? void 0 : _a.extMatch) && !matched && !(0, tslib_1.__classPrivateFieldGet)(this, _MLEngine_file, "f").path.match(/\.html?$/i)) {
-            this.emit('log', 'extension-matching', `${(0, tslib_1.__classPrivateFieldGet)(this, _MLEngine_file, "f").path}`);
+        const checkingExt = !((_a = (0, tslib_1.__classPrivateFieldGet)(this, _MLEngine_options, "f")) === null || _a === void 0 ? void 0 : _a.ignoreExt);
+        if (checkingExt && !matched) {
+            this.emit('log', 'ext-unmatched', `Avoided linting because a file is unmatched by the extension: ${(0, tslib_1.__classPrivateFieldGet)(this, _MLEngine_file, "f").path}`);
             return null;
         }
         const ruleset = this.resolveRuleset(configSet);

package/lib/api/types.d.ts

@@ -4,40 +4,47 @@ import type { MLMarkupLanguageParser } from '@markuplint/ml-ast';
 import type { Config, Violation, ParserOptions } from '@markuplint/ml-config';
 import type { AnyMLRule, MLSchema, Ruleset } from '@markuplint/ml-core';
 export declare type APIOptions = {
-    configFile?: string;
-    config?: Config;
-    defaultConfig?: Config;
-    noSearchConfig?: boolean;
-    locale?: string;
-    fix?: boolean;
-    extMatch?: boolean;
-    rules?: AnyMLRule[];
-    importPresetRules?: boolean;
-    /**
-     * @deprecated
-     */
-    autoLoad?: boolean;
+	configFile?: string;
+	config?: Config;
+	defaultConfig?: Config;
+	noSearchConfig?: boolean;
+	locale?: string;
+	fix?: boolean;
+	ignoreExt?: boolean;
+	rules?: AnyMLRule[];
+	importPresetRules?: boolean;
+	/**
+	 * @deprecated
+	 */
+	autoLoad?: boolean;
 };
 export declare type MLFabric = {
-    ruleset: Ruleset;
-    rules: AnyMLRule[];
-    schemas: MLSchema;
-    parser: MLMarkupLanguageParser;
-    parserOptions: ParserOptions;
-    locale: LocaleSet;
-    configErrors?: Error[];
+	ruleset: Ruleset;
+	rules: AnyMLRule[];
+	schemas: MLSchema;
+	parser: MLMarkupLanguageParser;
+	parserOptions: ParserOptions;
+	locale: LocaleSet;
+	configErrors?: Error[];
 };
 export declare type MLEngineEventMap = {
-    log: (phase: string, message: string) => void;
-    config: (filePath: string, config: ConfigSet, message?: string) => void;
-    exclude: (filePath: string, setting: string, message?: string) => void;
-    parser: (filePath: string, parser: string, message?: string) => void;
-    ruleset: (filePath: string, ruleset: Ruleset, message?: string) => void;
-    schemas: (filePath: string, schemas: MLSchema, message?: string) => void;
-    rules: (filePath: string, rules: AnyMLRule[], message?: string) => void;
-    i18n: (filePath: string, locale: LocaleSet, message?: string) => void;
-    code: (filePath: string, sourceCode: string, message?: string) => void;
-    lint: (filePath: string, sourceCode: string, violations: Violation[], fixedCode: string, debug: string[] | null, message?: string) => void;
-    'lint-error': (filePath: string, sourceCode: string, error: Error) => void;
-    'config-errors': (filePath: string, errors: Error[]) => void;
+	log: (phase: string, message: string) => void;
+	config: (filePath: string, config: ConfigSet, message?: string) => void;
+	exclude: (filePath: string, setting: string, message?: string) => void;
+	parser: (filePath: string, parser: string, message?: string) => void;
+	ruleset: (filePath: string, ruleset: Ruleset, message?: string) => void;
+	schemas: (filePath: string, schemas: MLSchema, message?: string) => void;
+	rules: (filePath: string, rules: AnyMLRule[], message?: string) => void;
+	i18n: (filePath: string, locale: LocaleSet, message?: string) => void;
+	code: (filePath: string, sourceCode: string, message?: string) => void;
+	lint: (
+		filePath: string,
+		sourceCode: string,
+		violations: Violation[],
+		fixedCode: string,
+		debug: string[] | null,
+		message?: string,
+	) => void;
+	'lint-error': (filePath: string, sourceCode: string, error: Error) => void;
+	'config-errors': (filePath: string, errors: Error[]) => void;
 };

package/lib/api/v1.d.ts

@@ -6,55 +6,46 @@ import type { MLRule } from '@markuplint/ml-core';
  * @returns
  */
 export declare function lint_v1(options: {
-    /**
-     * Glob pattern
-     */
-    files?: string | string[];
-    /**
-     * Target source code of evaluation
-     */
-    sourceCodes?: string | string[];
-    /**
-     * File names when `sourceCodes`
-     */
-    names?: string | string[];
-    /**
-     * Workspace path when `sourceCodes`
-     */
-    workspace?: string;
-    /**
-     * Configure file or object
-     */
-    config?: string | Config;
-    /**
-     * The config applied when not resolved from files or set it explicitly.
-     */
-    defaultConfig?: Config;
-    /**
-     * Rules (default: `@markuplint/rules`)
-     */
-    rules?: MLRule<RuleConfigValue, unknown>[];
-    /**
-     * Auto resolve rules
-     *
-     * Auto importing form *node_modules* when set `@markuplint/rule-{RULE_NAME}` or `markuplint-rule-{RULE_NAME}` in config rules
-     */
-    rulesAutoResolve?: boolean;
-    /**
-     * Auto fix
-     */
-    fix?: boolean;
-    /**
-     * Locale
-     */
-    locale?: string;
-    /**
-     * Confirm the extension of the target file to the regexp of parser plugins.
-     * It doesn't run the linting if it doesn't match.
-     * If you don't set a parser plugin and the target file is HTML, It confirms the regexp as `/\.html?$/i`.
-     * Default is false.
-     *
-     * @default false
-     */
-    extMatch?: boolean;
-}): Promise<import("..").MLResultInfo[]>;
+	/**
+	 * Glob pattern
+	 */
+	files?: string | string[];
+	/**
+	 * Target source code of evaluation
+	 */
+	sourceCodes?: string | string[];
+	/**
+	 * File names when `sourceCodes`
+	 */
+	names?: string | string[];
+	/**
+	 * Workspace path when `sourceCodes`
+	 */
+	workspace?: string;
+	/**
+	 * Configure file or object
+	 */
+	config?: string | Config;
+	/**
+	 * The config applied when not resolved from files or set it explicitly.
+	 */
+	defaultConfig?: Config;
+	/**
+	 * Rules (default: `@markuplint/rules`)
+	 */
+	rules?: MLRule<RuleConfigValue, unknown>[];
+	/**
+	 * Auto resolve rules
+	 *
+	 * Auto importing form *node_modules* when set `@markuplint/rule-{RULE_NAME}` or `markuplint-rule-{RULE_NAME}` in config rules
+	 */
+	rulesAutoResolve?: boolean;
+	/**
+	 * Auto fix
+	 */
+	fix?: boolean;
+	/**
+	 * Locale
+	 */
+	locale?: string;
+}): Promise<import('..').MLResultInfo[]>;

package/lib/api/v1.js

@@ -40,7 +40,6 @@ async function lint_v1(options) {
         noSearchConfig: !options.files,
         rules: options.rules,
         autoLoad: (_a = options.rulesAutoResolve) !== null && _a !== void 0 ? _a : true,
-        extMatch: options.extMatch,
         locale: options.locale,
     });
     return result;

package/lib/cli/bootstrap.d.ts

@@ -1,38 +1,54 @@
 import meow from 'meow';
-export declare const help = "\nUsage\n\t$ markuplint <HTML file pathes (glob format)>\n\t$ <stdout> | markuplint\n\nOptions\n\t--config-file,  -c FILE_PATH  Ruleset file path.\n\t--fix,                        Fix HTML.\n\t--format,       -f FORMAT     Output format. Support \"JSON\", \"Simple\" and \"Standard\". Default: \"Standard\".\n\t--no-color,                   Output no color.\n\t--problem-only, -p            Output only problems, without passeds.\n\t--verbose                     Output with detailed information.\n\n\t--init                        Initialize settings interactively.\n\t--create-rule                 Add the scaffold of a custom rule.\n\n\t--help,         -h            Show help.\n\t--version,      -v            Show version.\n\nExamples\n\t$ markuplint verifyee.html --ruleset path/to/.markuplintrc\n\t$ cat verifyee.html | markuplint\n";
+export declare const help =
+	'\nUsage\n\t$ markuplint <HTML file pathes (glob format)>\n\t$ <stdout> | markuplint\n\nOptions\n\t--config,                -c FILE_PATH  A configuration file path.\n\t--fix,                                 Fix HTML.\n\t--format,                -f FORMAT     Output format. Support "JSON", "Simple" and "Standard". Default: "Standard".\n\t--no-search-config                     No search a configure file automatically.\n\t--ignore-ext                           Evaluate files that are received even though the type of extension.\n\t--no-import-preset-rules               No import preset rules.\n\t--locale                               Locale of the message of violation. Default is an OS setting.\n\t--no-color,                            Output no color.\n\t--problem-only,          -p            Output only problems, without passeds.\n\t--verbose                              Output with detailed information.\n\n\t--init                                 Initialize settings interactively.\n\t--create-rule                          Add the scaffold of a custom rule.\n\n\t--help,                  -h            Show help.\n\t--version,               -v            Show version.\n\nExamples\n\t$ markuplint verifyee.html --config path/to/.markuplintrc\n\t$ cat verifyee.html | markuplint\n';
 export declare const cli: meow.Result<{
-    init: {
-        type: "boolean";
-        default: false;
-    };
-    createRule: {
-        type: "boolean";
-        default: false;
-    };
-    configFile: {
-        type: "string";
-        alias: string;
-    };
-    fix: {
-        type: "boolean";
-        default: false;
-    };
-    format: {
-        type: "string";
-        alias: string;
-    };
-    color: {
-        type: "boolean";
-        default: true;
-    };
-    problemOnly: {
-        type: "boolean";
-        alias: string;
-        default: false;
-    };
-    verbose: {
-        type: "boolean";
-        default: false;
-    };
+	config: {
+		type: 'string';
+		alias: string;
+	};
+	fix: {
+		type: 'boolean';
+		default: false;
+	};
+	format: {
+		type: 'string';
+		alias: string;
+	};
+	searchConfig: {
+		type: 'boolean';
+		default: true;
+	};
+	ignoreExt: {
+		type: 'boolean';
+		default: false;
+	};
+	importPresetRules: {
+		type: 'boolean';
+		default: true;
+	};
+	locale: {
+		type: 'string';
+	};
+	color: {
+		type: 'boolean';
+		default: true;
+	};
+	problemOnly: {
+		type: 'boolean';
+		alias: string;
+		default: false;
+	};
+	verbose: {
+		type: 'boolean';
+		default: false;
+	};
+	init: {
+		type: 'boolean';
+		default: false;
+	};
+	createRule: {
+		type: 'boolean';
+		default: false;
+	};
 }>;
 export declare type CLIOptions = typeof cli.flags;

package/lib/cli/bootstrap.js

@@ -9,34 +9,30 @@ Usage
 	$ <stdout> | markuplint
 
 Options
-	--config-file,  -c FILE_PATH  Ruleset file path.
-	--fix,                        Fix HTML.
-	--format,       -f FORMAT     Output format. Support "JSON", "Simple" and "Standard". Default: "Standard".
-	--no-color,                   Output no color.
-	--problem-only, -p            Output only problems, without passeds.
-	--verbose                     Output with detailed information.
+	--config,                -c FILE_PATH  A configuration file path.
+	--fix,                                 Fix HTML.
+	--format,                -f FORMAT     Output format. Support "JSON", "Simple" and "Standard". Default: "Standard".
+	--no-search-config                     No search a configure file automatically.
+	--ignore-ext                           Evaluate files that are received even though the type of extension.
+	--no-import-preset-rules               No import preset rules.
+	--locale                               Locale of the message of violation. Default is an OS setting.
+	--no-color,                            Output no color.
+	--problem-only,          -p            Output only problems, without passeds.
+	--verbose                              Output with detailed information.
 
-	--init                        Initialize settings interactively.
-	--create-rule                 Add the scaffold of a custom rule.
+	--init                                 Initialize settings interactively.
+	--create-rule                          Add the scaffold of a custom rule.
 
-	--help,         -h            Show help.
-	--version,      -v            Show version.
+	--help,                  -h            Show help.
+	--version,               -v            Show version.
 
 Examples
-	$ markuplint verifyee.html --ruleset path/to/.markuplintrc
+	$ markuplint verifyee.html --config path/to/.markuplintrc
 	$ cat verifyee.html | markuplint
 `;
 exports.cli = (0, meow_1.default)(exports.help, {
     flags: {
-        init: {
-            type: 'boolean',
-            default: false,
-        },
-        createRule: {
-            type: 'boolean',
-            default: false,
-        },
-        configFile: {
+        config: {
             type: 'string',
             alias: 'c',
         },
@@ -48,6 +44,21 @@ exports.cli = (0, meow_1.default)(exports.help, {
             type: 'string',
             alias: 'f',
         },
+        searchConfig: {
+            type: 'boolean',
+            default: true,
+        },
+        ignoreExt: {
+            type: 'boolean',
+            default: false,
+        },
+        importPresetRules: {
+            type: 'boolean',
+            default: true,
+        },
+        locale: {
+            type: 'string',
+        },
         color: {
             type: 'boolean',
             default: true,
@@ -61,5 +72,13 @@ exports.cli = (0, meow_1.default)(exports.help, {
             type: 'boolean',
             default: false,
         },
+        init: {
+            type: 'boolean',
+            default: false,
+        },
+        createRule: {
+            type: 'boolean',
+            default: false,
+        },
     },
 });

package/lib/cli/command.js

@@ -10,7 +10,12 @@ const debug_1 = require("../debug");
 const output_1 = require("./output");
 async function command(files, options) {
     const fix = options.fix;
-    const configFile = options.configFile && path_1.default.join(process.cwd(), options.configFile);
+    const configFile = options.config && path_1.default.join(process.cwd(), options.config);
+    const locale = options.locale;
+    const searchConfig = options.searchConfig;
+    const ignoreExt = options.ignoreExt;
+    const importPresetRules = options.importPresetRules;
+    const verbose = options.verbose;
     const fileList = await (0, file_resolver_1.resolveFiles)(files);
     if (debug_1.log.enabled) {
         (0, debug_1.log)('File list: %O', fileList.map(f => f.path));
@@ -19,7 +24,15 @@ async function command(files, options) {
     }
     let hasError = false;
     for (const file of fileList) {
-        const engine = new api_1.MLEngine(file, { configFile });
+        const engine = new api_1.MLEngine(file, {
+            configFile,
+            fix,
+            locale,
+            noSearchConfig: !searchConfig,
+            ignoreExt,
+            importPresetRules,
+            debug: verbose,
+        });
         const result = await engine.exec();
         if (!result) {
             continue;

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

@@ -4,9 +4,12 @@ exports.createRule = void 0;
 const tslib_1 = require("tslib");
 const create_rule_helper_1 = require("@markuplint/create-rule-helper");
 const cli_color_1 = (0, tslib_1.__importDefault)(require("cli-color"));
+const util_1 = require("../../util");
 const install_module_1 = require("../init/install-module");
 const prompt_1 = require("../prompt");
 async function createRule() {
+    (0, util_1.write)((0, util_1.head)('Create a rule'));
+    util_1.write.break();
     const purpose = await (0, prompt_1.select)({
         message: 'What purpose do you create the rule for?',
         choices: [
@@ -49,5 +52,5 @@ function output(name, icon, title, path) {
     const _marker = cli_color_1.default.xterm(39)('✔') + ' ';
     const _title = (icon, title) => `${icon} ` + cli_color_1.default.bold(`${name}/${title}`);
     const _file = (path) => ' ' + cli_color_1.default.cyanBright(path);
-    process.stdout.write(_marker + _title(icon, title) + _file(path) + '\n');
+    (0, util_1.write)(_marker + _title(icon, title) + _file(path));
 }

package/lib/cli/head.d.ts

@@ -0,0 +1 @@
+export declare const head: string;