pjj 0.0.0 → 0.1.0

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) <2025> <earthnut.dev@outlook.com>
+    
+Permission to use, copy, modify, and/or distribute this software for any  
+purpose with or without fee is hereby granted, provided that the above  
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES  
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF  
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR  
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES  
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN  
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF  
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -1,3 +1,77 @@
-# 这个名被我占用了
+# pjj
 
-但是你如果有需要，可以 [邮我转让](mailto:earthnut.dev@outlook.com)
+[![version](<https://img.shields.io/npm/v/pjj.svg?logo=npm&logoColor=rgb(0,0,0)&label=版本号&labelColor=rgb(73,73,228)&color=rgb(0,0,0)>)](https://www.npmjs.com/package/pjj) [![NPM Last Update](<https://img.shields.io/npm/last-update/pjj?logo=npm&label=版本最后更新&labelColor=rgb(255,36,63)&color=rgb(0,0,0)>)](https://www.npmjs.com/package/pjj) [![📦 size](<https://img.shields.io/bundlephobia/minzip/pjj.svg?logo=npm&label=压缩包大小&labelColor=rgb(201,158,140)&color=rgb(0,0,0)>)](https://www.npmjs.com/package/pjj) [![downloads](<https://img.shields.io/npm/dm/pjj.svg?logo=npm&logoColor=rgb(0,0,0)&label=月下载量&labelColor=rgb(194,112,210)&color=rgb(0,0,0)>)](https://www.npmjs.com/package/pjj) [![downloads](<https://img.shields.io/npm/dt/pjj.svg?logo=npm&label=总下载量&labelColor=rgb(107,187,124)&color=rgb(0,0,0)>)](https://www.npmjs.com/package/pjj)
+
+[![last commit](<https://img.shields.io/github/last-commit/earthnutDev/pjj.svg?logo=github&logoColor=rgb(0,0,0)&label=最后推码&labelColor=rgb(255,165,0)&color=rgb(0,0,0)>)](https://github.com/earthnutDev/pjj) [![GitHub commit activity](<https://img.shields.io/github/commit-activity/y/earthnutDev/pjj.svg?logo=github&label=推码数&labelColor=rgb(128,0,128)&color=rgb(0,0,0)>)](https://github.com/earthnutDev/pjj) [![Coverage Status](<https://img.shields.io/coverallsCoverage/github/earthnutDev/pjj?logo=coveralls&label=coveralls&labelColor=rgb(12, 244, 39)&color=rgb(0,0,0)>)](https://coveralls.io/github/earthnutDev/pjj?branch=main) [![codecov](<https://img.shields.io/codecov/c/github/earthnutDev/pjj/main?logo=codecov&label=codecov&labelColor=rgb(7, 245, 245)&color=rgb(0,0,0)>)](https://codecov.io/gh/earthnutDev/pjj)
+
+[![查看 📔 日志](<https://img.shields.io/badge/👀-日_%20_志-rgb(0,125,206)>)](https://github.com/earthnutDev/pjj/blob/main/CHANGELOG.md) [![bug 🙋‍♂️ 提交](<https://img.shields.io/badge/☣️-bug_%20_提交-rgb(255,0,63)>)](https://github.com/earthnutDev/pjj/issues)
+
+---
+
+_发现个更简单的方法，直接在 `package.json` 中添加 `private: true` 更简单粗暴_
+
+禁止在项目的根目录执行 npm publish，防止意外发布。该脚本命令仅允许在 `prepublishOnly` ` 钩子中执行。
+
+因为我的项目都是打包到 `dist` 目录下，然后再 `cd dist` 在 dist 目录下执行 `npm publish`，所以需要禁止在根目录执行 `npm publish`。
+
+因为偶尔会忘记在 `dist` 目录下执行 `npm publish`，所以需要该脚本命令。
+
+_我构建后的 `package.json` 🀄️不包含 `scripts` 字段，所以仅考虑根目录禁止执行 `npm publish`_
+
+## 安装
+
+```bash
+npm install pjj --save-dev
+```
+
+## 使用
+
+### 常规使用
+
+```json
+{
+  "scripts": {
+    "prepublishOnly": "pjj"
+  }
+}
+```
+
+### 替换掉默认文本
+
+```json
+{
+  "scripts": {
+    "prepublishOnly": "pjj -m '请在 dist 目录下执行 npm publish'"
+  }
+}
+```
+
+### 替换掉默认文本并使用黑色（默认）文本颜色
+
+```json
+{
+  "scripts": {
+    "prepublishOnly": "pjj -m '请在 dist 目录下执行 npm publish' -b"
+  }
+}
+```
+
+需要注意
+
+- 添加了 `-s` 命令用于替换默认 prepublishOnly，但是还不知道怎么用，慎用
+- 在使用命令 `pjj` 时，需保证在项目中进行了安装
+- 只要将该命令配置到 `"prepublishOnly": "pjj"` 时，总会在执行 `npm publish` 时阻止执行 `npm publish`
+- 该命令仅适用于 `npm publish`
+- 使用该命令请不要使用 `npx` 调用，除非配置 `-s npx` 命令
+
+```json
+{
+  "scripts": {
+    "prepublishOnly": "npx pjj -s npx"
+  }
+}
+```
+
+## 文档地址
+
+参看 [https://earthnut.dev/pjj/](https://earthnut.dev/pjj/)

package/bin/pjj.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+'use strict';
+
+import '../mjs/index.mjs';

package/mjs/index.mjs

@@ -0,0 +1,3 @@
+import { main } from './src/main.mjs';
+
+main();

package/mjs/src/cn.mjs

@@ -0,0 +1,3 @@
+const cn = process.env.LANG?.toLocaleLowerCase().includes('zh');
+
+export { cn };

package/mjs/src/colorText.mjs

@@ -0,0 +1,25 @@
+import { pen } from 'color-pen';
+import { noColor } from './command.mjs';
+
+/**
+ *
+ * @description 生成随机颜色文本
+ * @param str 字符串
+ * @param text 是否不使用颜色
+ *
+ *
+ */
+function colorText(str, text = true) {
+    return `${' '.repeat(7)}${str}${' '.repeat(7)}`
+        .split('')
+        .map(char => noColor
+        ? text
+            ? char
+            : pen.hide(char)
+        : text
+            ? pen.random.bgBlack(char)
+            : pen.random.bgBlack.hide(char))
+        .join('');
+}
+
+export { colorText };

package/mjs/src/command.mjs

@@ -0,0 +1,31 @@
+import { Command } from 'a-command';
+import { cn } from './cn.mjs';
+
+/**  创建一个命令  */
+const command = new Command('pjj');
+command
+    .bind({
+    'message <-m> (添加自定义的命令消息)': [],
+    'black <-b> (显示为黑色（默认）文本)': [],
+    'script <-s> (触发的勾子，默认为 prepublishOnly)': [],
+})
+    .run().isEnd.end;
+/**
+ *  命令参数映射
+ */
+const argMap = command.args.$map;
+/**
+ *  命令参数值
+ */
+const message = argMap.message && argMap.message.value && argMap.message.value.length > 0
+    ? argMap.message.value.join('\n')
+    : cn
+        ? '禁止在项目的根目录下执行 npm publish 命令'
+        : 'It is forbidden to execute the npm publish command in the root directory of the project';
+/// 没有颜色
+const noColor = argMap.black !== undefined;
+const script = argMap.script && argMap.script.value && argMap.script.value.length > 0
+    ? argMap.script.value[0]
+    : 'prepublishOnly';
+
+export { command, message, noColor, script };

package/mjs/src/line.mjs

@@ -0,0 +1,18 @@
+import pen from 'color-pen';
+import { cn } from './cn.mjs';
+import { noColor } from './command.mjs';
+
+/**
+ *
+ * @description 生成分割线
+ *
+ */
+function line() {
+    let str = '';
+    for (let i = 0; i < (cn ? 54 : 101); i++) {
+        str += noColor ? '=' : pen.random('=');
+    }
+    return str;
+}
+
+export { line };

package/mjs/src/main.mjs

@@ -0,0 +1,40 @@
+import pen from 'color-pen';
+import { colorText } from './colorText.mjs';
+import { script, message } from './command.mjs';
+import { line } from './line.mjs';
+import { _p } from 'a-node-tools';
+
+/**
+ *  空行
+ */
+const space = '\n'.repeat(3);
+/**
+ * 主程序入口
+ */
+function main() {
+    if (process && process.env && process.env.npm_lifecycle_event === script) {
+        _p(space);
+        _p(line());
+        _p(colorText(message, false));
+        _p(colorText(message, false));
+        _p(colorText(message));
+        _p(colorText(message, false));
+        _p(colorText(message, false));
+        _p(line());
+        _p(space);
+        end();
+    }
+    else {
+        const m = '     所以，看见这段文本，说明你哪里 ❌ 了     ';
+        _p('====================================');
+        _p('跳过了禁止发布，而且该命令可能不会显示在终端\n');
+        _p(pen.hide.brightRed.bgBlack(m));
+        _p(pen.bold.blink.brightRed.bgBlack(m));
+        _p(pen.hide.brightRed.bgBlack(m));
+        _p('\n====================================');
+    }
+}
+/**    命令结束回调  */
+const end = () => process.exit(1);
+
+export { end, main };

package/package.json

@@ -1,26 +1,49 @@
 {
   "name": "pjj",
-  "version": "0.0.0",
-  "main": "index.js",
-  "author": "lmssee <lmssee@outlook.com>  (https://lmssee.com)",
-  "homepage": "https://earthnut.dev/vue",
-  "license": "ISC",
-  "description": "但是你如果有需要，可以邮我转让 <earthnut.dev@outlook.com>",
+  "type": "module",
+  "version": "0.1.0",
+  "module": "./mjs/index.mjs",
+  "author": {
+    "name": "earthnut",
+    "email": "earthnut.dev@outlook.com",
+    "url": "https://earthnut.dev"
+  },
+  "description": "禁止在项目的根目录执行 npm publish，防止意外发布。该脚本命令仅允许在 `prepublishOnly`  ` 钩子中执行。",
   "files": [
-    "index.js"
+    "mjs",
+    "bin"
   ],
-  "bugs": {
-    "url": "https://github.com/lmssee/npm-earthnut-vue/issues"
+  "exports": {
+    ".": {
+      "import": {
+        "default": "./mjs/index.mjs",
+        "types": "./types/index.d.ts"
+      }
+    }
   },
   "keywords": [
-    "earthnut"
+    "pjj"
   ],
+  "license": "ISC",
+  "homepage": "https://earthnut.dev/pjj",
+  "bugs": {
+    "url": "https://github.com/earthnutDev/gtu/issues",
+    "email": "earthnut.dev@outlook.com"
+  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/lmssee/npm-earthnut-vue.git"
+    "url": "git+https://github.com/earthnutDev/pjj.git"
   },
   "publishConfig": {
     "access": "public",
-    "registry": "https://registry.npmjs.org"
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "a-command": "^0.0.8",
+    "a-node-tools": "^0.1.0",
+    "color-pen": "^0.1.0"
+  },
+  "bin": {
+    "pjj": "bin/pjj.js"
   }
-}
+}

package/index.js

@@ -1 +0,0 @@
-console.log("hello ,iggg!");