ydz-first-package 1.0.0

package/README.md

@@ -0,0 +1,54 @@
+# my-first-npm-package
+
+一个示例 npm 包，用于演示如何发布到 npm。
+
+## 安装
+
+```bash
+npm install my-first-npm-package
+```
+
+## 使用方法
+
+```javascript
+const myPackage = require('my-first-npm-package');
+
+// 问候
+console.log(myPackage.greet('npm')); // 输出: Hello, npm!
+
+// 加法
+console.log(myPackage.add(2, 3)); // 输出: 5
+
+// 格式化日期
+console.log(myPackage.formatDate()); // 输出: 当前日期的格式化字符串
+```
+
+## API
+
+### `greet(name)`
+问候函数
+
+- `name` (string): 要问候的名字，默认为 'World'
+- 返回: 问候语字符串
+
+### `add(a, b)`
+加法函数
+
+- `a` (number): 第一个数字
+- `b` (number): 第二个数字
+- 返回: 两数之和
+
+### `formatDate(date)`
+格式化日期
+
+- `date` (Date): 日期对象，默认为当前日期
+- 返回: 格式化后的日期字符串
+
+## 许可证
+
+MIT
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request！
+

package/index.js

@@ -0,0 +1,44 @@
+/**
+ * 示例 npm 包
+ * 这是一个简单的工具函数库示例
+ */
+
+/**
+ * 问候函数
+ * @param {string} name - 要问候的名字
+ * @returns {string} 问候语
+ */
+function greet(name = 'World') {
+  return `Hello, ${name}!`;
+}
+
+/**
+ * 加法函数
+ * @param {number} a - 第一个数字
+ * @param {number} b - 第二个数字
+ * @returns {number} 两数之和
+ */
+function add(a, b) {
+  return a + b;
+}
+
+/**
+ * 格式化日期
+ * @param {Date} date - 日期对象
+ * @returns {string} 格式化后的日期字符串
+ */
+function formatDate(date = new Date()) {
+  return date.toLocaleDateString('zh-CN', {
+    year: 'numeric',
+    month: 'long',
+    day: 'numeric'
+  });
+}
+
+// 导出函数
+module.exports = {
+  greet,
+  add,
+  formatDate
+};
+

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "ydz-first-package",
+  "version": "1.0.0",
+  "description": "一个示例 npm 包，用于演示如何发布到 npm",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "npm",
+    "package",
+    "example"
+  ],
+  "author": "xinan",
+  "license": "MIT"
+}
+