@deppon/deppon-norm 2.2.0 → 2.2.2

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 xingxing
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 xingxing
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,119 +1,119 @@
-# `@deppon/deppon-norm`
-
-前端规范工具包
-
-## 安装
-
-```bash
-npm install @deppon/deppon-norm
-```
-
-## 基础使用
-
-### JavaScript/TypeScript 项目
-
-```javascript
-import { commit, note, start, stylelint } from '@deppon/deppon-norm';
-
-// 使用 commit
-commit('commit message');
-
-// 使用 note
-note('note message');
-
-// 使用 start
-start('start message');
-
-// 使用 stylelint
-stylelint('stylelint message');
-```
-
-## Vue 3 使用
-
-### 1. 安装插件
-
-在 Vue 应用中安装插件：
-
-```javascript
-import { createApp } from 'vue';
-import { VuePlugin } from '@deppon/deppon-norm';
-
-const app = createApp(App);
-
-// 安装插件
-app.use(VuePlugin);
-
-app.mount('#app');
-```
-
-### 2. 在 Composition API 中使用
-
-```vue
-<script setup>
-import { useNorm } from '@deppon/deppon-norm';
-
-const norm = useNorm();
-
-const handleCommit = () => {
-    norm.commit('commit message');
-};
-
-const handleNote = () => {
-    norm.note('note message');
-};
-
-const handleStart = () => {
-    norm.start('start message');
-};
-
-const handleStylelint = () => {
-    norm.stylelint('stylelint message');
-};
-</script>
-
-<template>
-    <button @click="handleCommit">Commit</button>
-    <button @click="handleNote">Note</button>
-    <button @click="handleStart">Start</button>
-    <button @click="handleStylelint">Stylelint</button>
-</template>
-```
-
-### 3. 在 Options API 中使用
-
-```vue
-<script>
-export default {
-    methods: {
-        handleCommit() {
-            // 通过 this.$norm 访问
-            this.$norm.commit('commit message');
-        },
-        handleNote() {
-            this.$norm.note('note message');
-        },
-        handleStart() {
-            this.$norm.start('start message');
-        },
-        handleStylelint() {
-            this.$norm.stylelint('stylelint message');
-        },
-    },
-};
-</script>
-```
-
-## API
-
-### Composition API
-
--   `useNorm()` - 获取 norm 实例
-
-### 方法
-
--   `commit(param1)` - Commit 方法
--   `note(param1)` - Note 方法
--   `start(param1)` - Start 方法
--   `stylelint(param1)` - Stylelint 方法
-
-更多 API 请参考源码。
+# `@deppon/deppon-norm`
+
+前端规范工具包
+
+## 安装
+
+```bash
+npm install @deppon/deppon-norm
+```
+
+## 基础使用
+
+### JavaScript/TypeScript 项目
+
+```javascript
+import { commit, note, start, stylelint } from '@deppon/deppon-norm';
+
+// 使用 commit
+commit('commit message');
+
+// 使用 note
+note('note message');
+
+// 使用 start
+start('start message');
+
+// 使用 stylelint
+stylelint('stylelint message');
+```
+
+## Vue 3 使用
+
+### 1. 安装插件
+
+在 Vue 应用中安装插件：
+
+```javascript
+import { createApp } from 'vue';
+import { VuePlugin } from '@deppon/deppon-norm';
+
+const app = createApp(App);
+
+// 安装插件
+app.use(VuePlugin);
+
+app.mount('#app');
+```
+
+### 2. 在 Composition API 中使用
+
+```vue
+<script setup>
+import { useNorm } from '@deppon/deppon-norm';
+
+const norm = useNorm();
+
+const handleCommit = () => {
+    norm.commit('commit message');
+};
+
+const handleNote = () => {
+    norm.note('note message');
+};
+
+const handleStart = () => {
+    norm.start('start message');
+};
+
+const handleStylelint = () => {
+    norm.stylelint('stylelint message');
+};
+</script>
+
+<template>
+    <button @click="handleCommit">Commit</button>
+    <button @click="handleNote">Note</button>
+    <button @click="handleStart">Start</button>
+    <button @click="handleStylelint">Stylelint</button>
+</template>
+```
+
+### 3. 在 Options API 中使用
+
+```vue
+<script>
+export default {
+    methods: {
+        handleCommit() {
+            // 通过 this.$norm 访问
+            this.$norm.commit('commit message');
+        },
+        handleNote() {
+            this.$norm.note('note message');
+        },
+        handleStart() {
+            this.$norm.start('start message');
+        },
+        handleStylelint() {
+            this.$norm.stylelint('stylelint message');
+        },
+    },
+};
+</script>
+```
+
+## API
+
+### Composition API
+
+-   `useNorm()` - 获取 norm 实例
+
+### 方法
+
+-   `commit(param1)` - Commit 方法
+-   `note(param1)` - Note 方法
+-   `start(param1)` - Start 方法
+-   `stylelint(param1)` - Stylelint 方法
+
+更多 API 请参考源码。

package/es/commit/index.d.ts

@@ -1,6 +1,6 @@
-export default commit;
-/**
- * 说明:
- *
- **/
-declare function commit(param1: any): void;
+export default commit;
+/**
+ * 说明:
+ *
+ **/
+declare function commit(param1: any): void;

package/es/commit/index.js

@@ -1,8 +1,8 @@
 import '../_virtual/_rollup-plugin-inject-process-env.js';
 
-/**
- * 说明: 
- *
+/**
+ * 说明: 
+ *
  **/
 function commit(param1) {
 }

package/es/composable.d.ts

@@ -1,20 +1,20 @@
-/**
- * Composition API: useNorm
- * 在 Vue 3 Composition API 中使用 norm
- *
- * @example
- * import { useNorm } from '@deppon/deppon-norm/vue'
- *
- * export default {
- *     setup() {
- *         const norm = useNorm()
- *
- *         const handleCommit = () => {
- *             norm.commit('commit message')
- *         }
- *
- *         return { handleCommit }
- *     }
- * }
- */
-export function useNorm(): any;
+/**
+ * Composition API: useNorm
+ * 在 Vue 3 Composition API 中使用 norm
+ *
+ * @example
+ * import { useNorm } from '@deppon/deppon-norm/vue'
+ *
+ * export default {
+ *     setup() {
+ *         const norm = useNorm()
+ *
+ *         const handleCommit = () => {
+ *             norm.commit('commit message')
+ *         }
+ *
+ *         return { handleCommit }
+ *     }
+ * }
+ */
+export function useNorm(): any;

package/es/composable.js

@@ -2,24 +2,24 @@ import './_virtual/_rollup-plugin-inject-process-env.js';
 import { inject, getCurrentInstance } from 'vue';
 import * as index from './index.js';
 
-/**
- * Composition API: useNorm
- * 在 Vue 3 Composition API 中使用 norm
- *
- * @example
- * import { useNorm } from '@deppon/deppon-norm/vue'
- *
- * export default {
- *     setup() {
- *         const norm = useNorm()
- *
- *         const handleCommit = () => {
- *             norm.commit('commit message')
- *         }
- *
- *         return { handleCommit }
- *     }
- * }
+/**
+ * Composition API: useNorm
+ * 在 Vue 3 Composition API 中使用 norm
+ *
+ * @example
+ * import { useNorm } from '@deppon/deppon-norm/vue'
+ *
+ * export default {
+ *     setup() {
+ *         const norm = useNorm()
+ *
+ *         const handleCommit = () => {
+ *             norm.commit('commit message')
+ *         }
+ *
+ *         return { handleCommit }
+ *     }
+ * }
  */
 function useNorm() {
   // 优先从 provide 获取

package/es/index.d.ts

@@ -1,6 +1,6 @@
-export { default as commit } from "./commit/index";
-export { default as note } from "./note/index";
-export { default as start } from "./start/index";
-export { default as stylelint } from "./stylelint/index";
-export { default as VuePlugin } from "./vue";
-export { useNorm } from "./composable";
+export { default as commit } from "./commit/index";
+export { default as note } from "./note/index";
+export { default as start } from "./start/index";
+export { default as stylelint } from "./stylelint/index";
+export { default as VuePlugin } from "./vue";
+export { useNorm } from "./composable";

package/es/note/index.d.ts

@@ -1,6 +1,6 @@
-export default note;
-/**
- * 说明:
- *
- **/
-declare function note(param1: any): void;
+export default note;
+/**
+ * 说明:
+ *
+ **/
+declare function note(param1: any): void;

package/es/note/index.js

@@ -1,8 +1,8 @@
 import '../_virtual/_rollup-plugin-inject-process-env.js';
 
-/**
- * 说明: 
- *
+/**
+ * 说明: 
+ *
  **/
 function note(param1) {
 }

package/es/start/index.d.ts

@@ -1,6 +1,6 @@
-export default start;
-/**
- * 说明:
- *
- **/
-declare function start(param1: any): void;
+export default start;
+/**
+ * 说明:
+ *
+ **/
+declare function start(param1: any): void;

package/es/start/index.js

@@ -1,8 +1,8 @@
 import '../_virtual/_rollup-plugin-inject-process-env.js';
 
-/**
- * 说明: 
- *
+/**
+ * 说明: 
+ *
  **/
 function start(param1) {
 }

package/es/stylelint/index.d.ts

@@ -1,6 +1,6 @@
-export default stylelint;
-/**
- * 说明:
- *
- **/
-declare function stylelint(param1: any): void;
+export default stylelint;
+/**
+ * 说明:
+ *
+ **/
+declare function stylelint(param1: any): void;

package/es/stylelint/index.js

@@ -1,8 +1,8 @@
 import '../_virtual/_rollup-plugin-inject-process-env.js';
 
-/**
- * 说明: 
- *
+/**
+ * 说明: 
+ *
  **/
 function stylelint(param1) {
 }

package/es/vue.d.ts

@@ -1,10 +1,10 @@
-declare namespace _default {
-    export { install };
-}
-export default _default;
-export { useNorm } from "./composable";
-/**
- * Vue 插件安装函数
- * @param {Object} app - Vue 应用实例
- */
-declare function install(app: Object): void;
+declare namespace _default {
+    export { install };
+}
+export default _default;
+export { useNorm } from "./composable";
+/**
+ * Vue 插件安装函数
+ * @param {Object} app - Vue 应用实例
+ */
+declare function install(app: Object): void;

package/es/vue.js

@@ -1,9 +1,9 @@
 import './_virtual/_rollup-plugin-inject-process-env.js';
 import * as index from './index.js';
 
-/**
- * Vue 插件安装函数
- * @param {Object} app - Vue 应用实例
+/**
+ * Vue 插件安装函数
+ * @param {Object} app - Vue 应用实例
  */
 function install(app) {
   // 注册全局属性

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@deppon/deppon-norm",
-    "version": "2.2.0",
+    "version": "2.2.2",
     "main": "es/index.js",
     "module": "es/index.js",
     "typings": "es/index.d.ts",