@varlet/release 0.3.2 → 0.3.3

package/README.md

@@ -6,7 +6,7 @@
 </p>
 <p align="center">
   <a href="https://www.npmjs.com/package/@varlet/release" target="_blank" rel="noopener noreferrer"><img src="https://badgen.net/npm/v/@varlet/release" alt="NPM Version" /></a>
-  <a href="https://github.com/varletjs/release/blob/main/LICENCE" target="_blank" rel="noopener noreferrer"><img src="https://badgen.net/github/license/varletjs/release" alt="License" /></a>
+  <a href="https://github.com/varletjs/release/blob/main/LICENSE" target="_blank" rel="noopener noreferrer"><img src="https://badgen.net/github/license/varletjs/release" alt="License" /></a>
 </p>
 
 ## Intro
@@ -66,6 +66,7 @@ npx vr publish
 | ----------------------------------- | -------------------------- |
 | -f --file \<filename\>              | Specify changelog filename |
 | -rc --releaseCount \<releaseCount\> | Release count              |
+| -p --preset \<preset\>              | Specify changelog preset   |
 
 #### lint-commit
 
@@ -88,7 +89,7 @@ npx vr publish
 #### Example
 
 ```js
-import { release, changelog } from '@varlet/release'
+import { changelog, release } from '@varlet/release'
 
 // Do what you want to do...
 release()
@@ -97,7 +98,7 @@ release()
 You can pass in a task that will be called before the publish after the package version is changed.
 
 ```js
-import { release, changelog } from '@varlet/release'
+import { changelog, release } from '@varlet/release'
 
 async function task() {
   await doSomething1()
@@ -130,8 +131,18 @@ function release(options: ReleaseCommandOptions): Promise<void>
 interface ChangelogCommandOptions {
   file?: string
   releaseCount?: number
+  preset?:
+    | 'angular'
+    | 'atom'
+    | 'codemirror'
+    | 'conventionalcommits'
+    | 'ember'
+    | 'eslint'
+    | 'express'
+    | 'jquery'
+    | 'jshint'
 }
-function changelog({ releaseCount, file }?: ChangelogCommandOptions): Promise<void>
+function changelog({ releaseCount, file, preset }?: ChangelogCommandOptions): Promise<void>
 
 const COMMIT_MESSAGE_RE: RegExp
 function isVersionCommitMessage(message: string): string | false | null
@@ -147,4 +158,4 @@ function commitLint(options: CommitLintCommandOptions): void
 
 ## License
 
-[MIT](https://github.com/varletjs/release/blob/main/LICENCE)
+[MIT](https://github.com/varletjs/release/blob/main/LICENSE)

package/README.zh-CN.md

@@ -66,6 +66,7 @@ npx vr publish
 | ----------------------------------- | ------------------ |
 | -f --file \<filename\>              | 指定变更日志文件名 |
 | -rc --releaseCount \<releaseCount\> | 发布数量           |
+| -p --preset \<preset\>              | 指定变更预设       |
 
 #### lint-commit
 
@@ -88,7 +89,7 @@ npx vr publish
 #### 示例
 
 ```js
-import { release, changelog } from '@varlet/release'
+import { changelog, release } from '@varlet/release'
 
 // Do what you want to do...
 release()
@@ -97,7 +98,7 @@ release()
 你可以传入一个 `task`，在包版本更改后，在发布之前会调用 `task`。
 
 ```js
-import { release, changelog } from '@varlet/release'
+import { changelog, release } from '@varlet/release'
 
 async function task() {
   await doSomething1()
@@ -130,8 +131,18 @@ function release(options: ReleaseCommandOptions): Promise<void>
 interface ChangelogCommandOptions {
   file?: string
   releaseCount?: number
+  preset?:
+    | 'angular'
+    | 'atom'
+    | 'codemirror'
+    | 'conventionalcommits'
+    | 'ember'
+    | 'eslint'
+    | 'express'
+    | 'jquery'
+    | 'jshint'
 }
-function changelog({ releaseCount, file }?: ChangelogCommandOptions): Promise<void>
+function changelog({ releaseCount, file, preset }?: ChangelogCommandOptions): Promise<void>
 
 const COMMIT_MESSAGE_RE: RegExp
 function isVersionCommitMessage(message: string): string | false | null
@@ -145,6 +156,6 @@ interface CommitLintCommandOptions {
 function commitLint(options: CommitLintCommandOptions): void
 ```
 
-## License
+## 许可证
 
 [MIT](https://github.com/varletjs/release/blob/main/LICENSE)

package/bin/index.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
-import { release, publish, changelog, commitLint } from '../dist/index.js'
 import { Command } from 'commander'
 import fse from 'fs-extra'
+import { changelog, commitLint, publish, release } from '../dist/index.js'
 
 const program = new Command()
 
@@ -18,21 +18,22 @@ program
   .option('-nt --npm-tag <npmTag>', 'Npm tag')
   .option('-c --check-remote-version', 'Check remote version')
   .description('Release all packages and generate changelogs')
-  .action(async (options) => release(options))
+  .action((options) => release(options))
 
 program
   .command('publish')
   .option('-c --check-remote-version', 'Check remote version')
   .option('-nt --npm-tag <npmTag>', 'Npm tag')
   .description('Publish to npm')
-  .action(async (options) => publish(options))
+  .action((options) => publish(options))
 
 program
   .command('changelog')
   .option('-rc --releaseCount <releaseCount>', 'Release count')
   .option('-f --file <file>', 'Changelog filename')
+  .option('-p --preset <preset>', 'Changelog preset')
   .description('Generate changelog')
-  .action(async (options) => changelog(options))
+  .action((options) => changelog(options))
 
 program
   .command('commit-lint')

package/dist/index.cjs

@@ -43,47 +43,29 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 
 // src/release.ts
+var import_path2 = require("path");
+var import_prompts = require("@inquirer/prompts");
 var import_fs_extra2 = __toESM(require("fs-extra"), 1);
-
-// src/logger.ts
-var import_picocolors = __toESM(require("picocolors"), 1);
-var logger_default = {
-  info(text) {
-    console.log(text);
-  },
-  success(text) {
-    console.log(import_picocolors.default.green(text));
-  },
-  warning(text) {
-    console.log(import_picocolors.default.yellow(text));
-  },
-  error(text) {
-    console.log(import_picocolors.default.red(text));
-  },
-  title(text) {
-    console.log(import_picocolors.default.cyan(text));
-  }
-};
-
-// src/release.ts
+var import_glob = require("glob");
+var import_nanospinner2 = require("nanospinner");
 var import_semver = __toESM(require("semver"), 1);
-var import_prompts = require("@inquirer/prompts");
 var import_tinyexec = require("tinyexec");
-var import_nanospinner2 = require("nanospinner");
-var import_glob = require("glob");
-var import_path2 = require("path");
 
 // src/changelog.ts
+var import_path = require("path");
 var import_conventional_changelog = __toESM(require("conventional-changelog"), 1);
 var import_fs_extra = __toESM(require("fs-extra"), 1);
 var import_nanospinner = require("nanospinner");
-var import_path = require("path");
 var { createWriteStream } = import_fs_extra.default;
-function changelog({ releaseCount = 0, file = "CHANGELOG.md" } = {}) {
+function changelog({
+  releaseCount = 0,
+  file = "CHANGELOG.md",
+  preset = "angular"
+} = {}) {
   const s = (0, import_nanospinner.createSpinner)("Generating changelog").start();
   return new Promise((resolve2) => {
     (0, import_conventional_changelog.default)({
-      preset: "angular",
+      preset,
       releaseCount
     }).pipe(createWriteStream((0, import_path.resolve)(process.cwd(), file))).on("close", () => {
       s.success({ text: "Changelog generated success!" });
@@ -92,6 +74,23 @@ function changelog({ releaseCount = 0, file = "CHANGELOG.md" } = {}) {
   });
 }
 
+// src/logger.ts
+var import_picocolors = __toESM(require("picocolors"), 1);
+var logger_default = {
+  info(text) {
+    console.log(text);
+  },
+  success(text) {
+    console.log(import_picocolors.default.green(text));
+  },
+  warning(text) {
+    console.log(import_picocolors.default.yellow(text));
+  },
+  error(text) {
+    console.log(import_picocolors.default.red(text));
+  }
+};
+
 // src/release.ts
 var cwd = process.cwd();
 var { writeFileSync, readJSONSync } = import_fs_extra2.default;
@@ -284,8 +283,8 @@ async function release(options) {
 }
 
 // src/commitLint.ts
-var import_semver2 = __toESM(require("semver"), 1);
 var import_fs_extra3 = __toESM(require("fs-extra"), 1);
+var import_semver2 = __toESM(require("semver"), 1);
 var { readFileSync } = import_fs_extra3.default;
 var COMMIT_MESSAGE_RE = /^(revert|fix|feat|docs|perf|test|types|style|build|chore|release|refactor|merge|wip)(\(.+\))?!?: (.|\n)+/;
 var ERROR_MESSAGE = "Commit message invalid.";

package/dist/index.d.cts

@@ -20,8 +20,9 @@ declare function release(options: ReleaseCommandOptions): Promise<void>;
 interface ChangelogCommandOptions {
     file?: string;
     releaseCount?: number;
+    preset?: 'angular' | 'atom' | 'codemirror' | 'conventionalcommits' | 'ember' | 'eslint' | 'express' | 'jquery' | 'jshint';
 }
-declare function changelog({ releaseCount, file }?: ChangelogCommandOptions): Promise<void>;
+declare function changelog({ releaseCount, file, preset, }?: ChangelogCommandOptions): Promise<void>;
 
 declare const COMMIT_MESSAGE_RE: RegExp;
 declare function isVersionCommitMessage(message: string): string | false | null;

package/dist/index.d.ts

@@ -20,8 +20,9 @@ declare function release(options: ReleaseCommandOptions): Promise<void>;
 interface ChangelogCommandOptions {
     file?: string;
     releaseCount?: number;
+    preset?: 'angular' | 'atom' | 'codemirror' | 'conventionalcommits' | 'ember' | 'eslint' | 'express' | 'jquery' | 'jshint';
 }
-declare function changelog({ releaseCount, file }?: ChangelogCommandOptions): Promise<void>;
+declare function changelog({ releaseCount, file, preset, }?: ChangelogCommandOptions): Promise<void>;
 
 declare const COMMIT_MESSAGE_RE: RegExp;
 declare function isVersionCommitMessage(message: string): string | false | null;

package/dist/index.js

@@ -1,45 +1,27 @@
 // src/release.ts
+import { resolve } from "path";
+import { confirm, select } from "@inquirer/prompts";
 import fse2 from "fs-extra";
-
-// src/logger.ts
-import pico from "picocolors";
-var logger_default = {
-  info(text) {
-    console.log(text);
-  },
-  success(text) {
-    console.log(pico.green(text));
-  },
-  warning(text) {
-    console.log(pico.yellow(text));
-  },
-  error(text) {
-    console.log(pico.red(text));
-  },
-  title(text) {
-    console.log(pico.cyan(text));
-  }
-};
-
-// src/release.ts
+import { glob } from "glob";
+import { createSpinner as createSpinner2 } from "nanospinner";
 import semver from "semver";
-import { confirm, select } from "@inquirer/prompts";
 import { x as exec } from "tinyexec";
-import { createSpinner as createSpinner2 } from "nanospinner";
-import { glob } from "glob";
-import { resolve } from "path";
 
 // src/changelog.ts
+import { resolve as resolvePath } from "path";
 import conventionalChangelog from "conventional-changelog";
 import fse from "fs-extra";
 import { createSpinner } from "nanospinner";
-import { resolve as resolvePath } from "path";
 var { createWriteStream } = fse;
-function changelog({ releaseCount = 0, file = "CHANGELOG.md" } = {}) {
+function changelog({
+  releaseCount = 0,
+  file = "CHANGELOG.md",
+  preset = "angular"
+} = {}) {
   const s = createSpinner("Generating changelog").start();
   return new Promise((resolve2) => {
     conventionalChangelog({
-      preset: "angular",
+      preset,
       releaseCount
     }).pipe(createWriteStream(resolvePath(process.cwd(), file))).on("close", () => {
       s.success({ text: "Changelog generated success!" });
@@ -48,6 +30,23 @@ function changelog({ releaseCount = 0, file = "CHANGELOG.md" } = {}) {
   });
 }
 
+// src/logger.ts
+import pico from "picocolors";
+var logger_default = {
+  info(text) {
+    console.log(text);
+  },
+  success(text) {
+    console.log(pico.green(text));
+  },
+  warning(text) {
+    console.log(pico.yellow(text));
+  },
+  error(text) {
+    console.log(pico.red(text));
+  }
+};
+
 // src/release.ts
 var cwd = process.cwd();
 var { writeFileSync, readJSONSync } = fse2;
@@ -240,8 +239,8 @@ async function release(options) {
 }
 
 // src/commitLint.ts
-import semver2 from "semver";
 import fse3 from "fs-extra";
+import semver2 from "semver";
 var { readFileSync } = fse3;
 var COMMIT_MESSAGE_RE = /^(revert|fix|feat|docs|perf|test|types|style|build|chore|release|refactor|merge|wip)(\(.+\))?!?: (.|\n)+/;
 var ERROR_MESSAGE = "Commit message invalid.";

package/package.json

@@ -1,7 +1,6 @@
 {
   "name": "@varlet/release",
-  "type": "module",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "publish all packages, generate changelogs and check commit messages",
   "keywords": [
     "varlet",
@@ -9,16 +8,14 @@
     "changelog",
     "commit-lint"
   ],
-  "author": "clencat <2091927351@qq.com>",
-  "license": "MIT",
+  "bugs": "https://github.com/varletjs/release/issues",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/varletjs/release"
   },
-  "bugs": "https://github.com/varletjs/release/issues",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "license": "MIT",
+  "author": "clencat <2091927351@qq.com>",
+  "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -26,12 +23,24 @@
       "require": "./dist/index.cjs"
     }
   },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "bin": {
     "vr": "bin/index.js"
   },
   "files": [
     "dist"
   ],
+  "scripts": {
+    "build": "tsup",
+    "clean": "rimraf node_modules dist",
+    "commit-lint": "node bin/index.js commit-lint",
+    "dev": "tsup --watch",
+    "format": "prettier --write .",
+    "lint": "eslint --fix .",
+    "release": "pnpm build && node bin/index.js release -c"
+  },
   "simple-git-hooks": {
     "pre-commit": "pnpm exec lint-staged --allow-empty --concurrent false",
     "commit-msg": "pnpm run commit-lint -p $1"
@@ -40,19 +49,29 @@
     "*.{ts,js}": [
       "prettier --write",
       "eslint --fix"
-    ]
+    ],
+    "*.md": "prettier --write"
   },
-  "engines": {
-    "node": ">=16.0.0",
-    "pnpm": ">=9.0"
+  "dependencies": {
+    "@inquirer/prompts": "^6.0.1",
+    "commander": "^11.1.0",
+    "conventional-changelog": "^5.1.0",
+    "fs-extra": "^11.1.1",
+    "glob": "^10.3.10",
+    "nanospinner": "^1.1.0",
+    "picocolors": "^1.0.0",
+    "semver": "^7.5.4",
+    "tinyexec": "^0.3.0"
   },
   "devDependencies": {
+    "@configurajs/eslint": "^0.1.0",
+    "@configurajs/prettier": "^0.1.1",
     "@types/conventional-changelog": "^3.1.5",
     "@types/fs-extra": "^11.0.4",
     "@types/node": "^20.9.0",
     "@types/semver": "^7.5.5",
     "@varlet/eslint-config": "^2.18.4",
-    "eslint": "^8.53.0",
+    "eslint": "^9.17.0",
     "lint-staged": "^15.2.0",
     "prettier": "^3.1.0",
     "rimraf": "^6.0.1",
@@ -60,24 +79,9 @@
     "tsup": "^8.3.0",
     "typescript": "^5.2.2"
   },
-  "dependencies": {
-    "@inquirer/prompts": "^6.0.1",
-    "commander": "^11.1.0",
-    "conventional-changelog": "^5.1.0",
-    "fs-extra": "^11.1.1",
-    "glob": "^10.3.10",
-    "nanospinner": "^1.1.0",
-    "picocolors": "^1.0.0",
-    "semver": "^7.5.4",
-    "tinyexec": "^0.3.0"
-  },
-  "scripts": {
-    "dev": "tsup --watch",
-    "build": "tsup",
-    "release": "pnpm build && node bin/index.js release -c",
-    "lint": "eslint . --ext .ts,.js",
-    "format": "prettier --write .",
-    "clean": "rimraf node_modules dist",
-    "commit-lint": "node bin/index.js commit-lint"
+  "packageManager": "pnpm@9.0.1",
+  "engines": {
+    "node": ">=16.0.0",
+    "pnpm": ">=9.0"
   }
 }