@markuplint/create-rule 5.2.0 → 5.3.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [5.3.0](https://github.com/markuplint/markuplint/compare/v5.2.0...v5.3.0) (2026-10-21)
+
+### Bug Fixes
+
+* make published packages loadable from require() and put types first ([723106f](https://github.com/markuplint/markuplint/commit/723106f51aac4e60dc02db2c1a894617368b0253)), closes [#4198](https://github.com/markuplint/markuplint/issues/4198)
+
+### Features
+
+* **create-rule:** add the package entry point for the programmatic API ([1b2b1c0](https://github.com/markuplint/markuplint/commit/1b2b1c0fa7ccc959cc69787103e19e475544e621))
+
+
 # [5.2.0](https://github.com/markuplint/markuplint/compare/v5.1.1...v5.2.0) (2026-10-13)
 
 ### Bug Fixes

package/lib/create-rule-helper-error.d.ts

@@ -1,3 +1,4 @@
+/** Thrown when the scaffold cannot be generated for a reason the caller can fix. */
 export declare class CreateRuleHelperError extends Error {
     name: string;
 }

package/lib/create-rule-helper-error.js

@@ -1,3 +1,4 @@
+/** Thrown when the scaffold cannot be generated for a reason the caller can fix. */
 export class CreateRuleHelperError extends Error {
     name = 'CreateRuleHelperError';
 }

package/lib/create-rule-helper.d.ts

@@ -1,2 +1,12 @@
 import type { CreateRuleHelperParams, CreateRuleHelperResult } from './types.js';
+/**
+ * Generates the scaffold of a new rule for the given purpose.
+ *
+ * @param params - What to generate and where (see {@link CreateRuleHelperParams}).
+ * `core` is required when `purpose` is `CONTRIBUTE_TO_CORE`.
+ * @returns The generated files and the dependencies to install.
+ * @throws {CreateRuleHelperError} The destination already exists or is not
+ * empty, `core` is missing for `CONTRIBUTE_TO_CORE`, or the markuplint
+ * repository cannot be found for it.
+ */
 export declare function createRuleHelper(params: CreateRuleHelperParams): Promise<CreateRuleHelperResult>;

package/lib/create-rule-helper.js

@@ -1,6 +1,16 @@
 import { createRulePackage } from './create-rule-package.js';
 import { createRuleToCore } from './create-rule-to-core.js';
 import { createRuleToProject } from './create-rule-to-project.js';
+/**
+ * Generates the scaffold of a new rule for the given purpose.
+ *
+ * @param params - What to generate and where (see {@link CreateRuleHelperParams}).
+ * `core` is required when `purpose` is `CONTRIBUTE_TO_CORE`.
+ * @returns The generated files and the dependencies to install.
+ * @throws {CreateRuleHelperError} The destination already exists or is not
+ * empty, `core` is missing for `CONTRIBUTE_TO_CORE`, or the markuplint
+ * repository cannot be found for it.
+ */
 export async function createRuleHelper(params) {
     switch (params.purpose) {
         case 'ADD_TO_PROJECT': {

package/lib/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @module @markuplint/create-rule
+ *
+ * Package entry point for the programmatic API behind the `create-rule` CLI
+ * (`bin/create-rule.mjs` imports `./cli.js` directly, not this file). Only the
+ * scaffold generator, its error class and its parameter/result types are
+ * public; the CLI wiring and the file-system helpers are not.
+ */
+export { createRuleHelper } from './create-rule-helper.js';
+export { CreateRuleHelperError } from './create-rule-helper-error.js';
+export type * from './types.js';

package/lib/index.js

@@ -0,0 +1,10 @@
+/**
+ * @module @markuplint/create-rule
+ *
+ * Package entry point for the programmatic API behind the `create-rule` CLI
+ * (`bin/create-rule.mjs` imports `./cli.js` directly, not this file). Only the
+ * scaffold generator, its error class and its parameter/result types are
+ * public; the CLI wiring and the file-system helpers are not.
+ */
+export { createRuleHelper } from './create-rule-helper.js';
+export { CreateRuleHelperError } from './create-rule-helper-error.js';

package/lib/types.d.ts

@@ -1,31 +1,46 @@
+/** Everything `createRuleHelper` needs: the rule to create and where it goes. */
 export type CreateRuleHelperParams = CreateRuleCreatorParams & {
+    /** Where the generated rule is placed. */
     readonly purpose: CreateRulePurpose;
 };
+/** The rule to generate, independent of its destination. */
 export type CreateRuleCreatorParams = {
+    /** Plugin or directory name (kebab-case). Unused for `CONTRIBUTE_TO_CORE`. */
     readonly pluginName: string;
+    /** Rule name (kebab-case). */
     readonly ruleName: string;
     readonly lang: CreateRuleLanguage;
+    /** Whether to generate a spec file. */
     readonly needTest: boolean;
+    /** Metadata for a core rule. Required for `CONTRIBUTE_TO_CORE`. */
     readonly core?: CreateRuleCreatorCoreParams;
 };
+/** Metadata of a rule generated for core (`category` goes to `meta.ts`, `severity` to `schema.json`). */
 export type CreateRuleCreatorCoreParams = {
     readonly description: string;
     readonly category: string;
     readonly severity: string;
 };
+/** What `createRuleHelper` generated. */
 export type CreateRuleHelperResult = {
     readonly files: readonly File[];
+    /** Packages the generated rule needs at runtime. */
     readonly dependencies: readonly string[];
+    /** Packages the generated rule needs for development and tests. */
     readonly devDependencies: readonly string[];
 };
+/** Language of the generated rule source. */
 export type CreateRuleLanguage = 'JAVASCRIPT' | 'TYPESCRIPT';
+/** Where the generated rule is placed: an existing project, a new package, or the markuplint repository. */
 export type CreateRulePurpose = 'ADD_TO_PROJECT' | 'PUBLISH_AS_PACKAGE' | 'CONTRIBUTE_TO_CORE';
+/** A file generated by `createRuleHelper`. */
 export type File = {
     readonly ext: string;
     /** Base name without extension or test suffix. */
     readonly name: string;
     /** Full file name including the test suffix, but without extension. */
     readonly fileName: string;
+    /** Whether this is a spec file. */
     readonly test: boolean;
     readonly destDir: string;
     readonly filePath: string;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/create-rule",
-	"version": "5.2.0",
+	"version": "5.3.0",
 	"description": "Rule generator for markuplint",
 	"repository": {
 		"type": "git",
@@ -15,8 +15,8 @@
 	"type": "module",
 	"exports": {
 		".": {
-			"import": "./lib/index.js",
-			"types": "./lib/index.d.ts"
+			"types": "./lib/index.d.ts",
+			"default": "./lib/index.js"
 		}
 	},
 	"bin": "./bin/create-rule.mjs",
@@ -29,15 +29,15 @@
 		"clean": "tsc --build --clean tsconfig.build.json"
 	},
 	"dependencies": {
-		"@markuplint/cli-utils": "5.2.0",
-		"@markuplint/ml-core": "5.2.0",
+		"@markuplint/cli-utils": "5.3.0",
+		"@markuplint/ml-core": "5.3.0",
 		"glob": "^13.0.6",
-		"prettier": "^3.9.9",
+		"prettier": "^3.9.10",
 		"typescript": "~6.0.3"
 	},
 	"devDependencies": {
 		"@types/fs-extra": "11.0.4",
 		"fs-extra": "11.4.1"
 	},
-	"gitHead": "d8b2feab77c9c862513615bea6b80d2817431878"
+	"gitHead": "f587cf0206c8426e57369a48d6d5fb22306eafde"
 }