一步步发布自己的npm包

前言:

做开发也有段时间了,一直在github上找寻别人发布的包,运用到自己的项目中。但是一直对怎样制作npm包,以及发布,和最后安装使用上的整个流程不了解。趁着最近项目上线,刚好有空闲时间可以搞个demo玩玩。

最新的一个项目是Vue+element-ui,要不就做一个自己的UI框架吧。

技术选型:

自从React 16.8出了之后,Function Component发布,可以作为替代Class Component使用,并且开发npm包,使用typescript类型检查可以避免很多开发中出现的错误。所以初始打算以React 16.8 + typescript + webpack开发一个自己的UI框架。

初始化:

mkdir UnnamedUI // 新建一个文件夹 名字就叫还没命名的UI吧
cd UnnamedUI
npm init // version: 0.0.1 生成package.json文件复制代码

一个好的npm项目,一定有一个规范的readme.md文档,具体可参照E lement-ui,或Antd的readme规范,目前先初始化一个readme

touch README.md复制代码

eslint规范也是必不可少的,特别是对于一个大的npm项目,多个团队合作,代码规范是增加效率,减少问题的主要。因为我们项目用了typescript,所以增加了部分typescript的规则。

touch .eslintrc.js复制代码
module.exports = {    root: true,    parser:  '@typescript-eslint/parser',    extends: [        'plugin:react/recommended',        'plugin:@typescript-eslint/recommended'    ],                              //使用推荐的React代码检测规范    plugins: ['@typescript-eslint'],    env:{        browser: true,        node: true,    },    settings: {             //自动发现React的版本,从而进行规范react代码        "react": {            "pragma": "React",            "version": "detect"        }    },    parserOptions: {        //指定ESLint可以解析JSX语法        "ecmaVersion": 2019,        "sourceType": 'module',        "ecmaFeatures":{            jsx:true        }    },    rules: {        "@typescript-eslint/no-explicit-any": "off",        "quotes": [2, "single"], //单引号        "no-console": 0, //不禁用console        "no-debugger": 2, //禁用debugger        "no-var": 0, //对var警告        "semi": 0, //不强制使用分号        "no-irregular-whitespace": 0, //不规则的空白不允许        "no-trailing-spaces": 1, //一行结束后面有空格就发出警告        "eol-last": 0, //文件以单一的换行符结束        "no-unused-vars": [2, {"vars": "all", "args": "after-used"}], //不能有声明后未被使用的变量或参数        "no-underscore-dangle": 0, //标识符不能以_开头或结尾        "no-alert": 2, //禁止使用alert confirm prompt        "no-lone-blocks": 0, //禁止不必要的嵌套块        "no-class-assign": 2, //禁止给类赋值        "no-cond-assign": 2, //禁止在条件表达式中使用赋值语句        "no-const-assign": 2, //禁止修改const声明的变量        "no-delete-var": 2, //不能对var声明的变量使用delete操作符        "no-dupe-keys": 2, //在创建对象字面量时不允许键重复        "no-duplicate-case": 2, //switch中的case标签不能重复        "no-dupe-args": 2, //函数参数不能重复        "no-empty": 2, //块语句中的内容不能为空        "no-func-assign": 2, //禁止重复的函数声明        "no-invalid-this": 0, //禁止无效的this,只能用在构造器,类,对象字面量        "no-redeclare": 2, //禁止重复声明变量        "no-spaced-func": 2, //函数调用时 函数名与()之间不能有空格        "no-this-before-super": 0, //在调用super()之前不能使用this或super        "no-undef": 2, //不能有未定义的变量        "no-use-before-define": 2, //未定义前不能使用        "camelcase": 0, //强制驼峰法命名        "jsx-quotes": [2, "prefer-double"], //强制在JSX属性(jsx-quotes)中一致使用双引号        "react/display-name": 0, //防止在React组件定义中丢失displayName        "react/forbid-prop-types": [2, {"forbid": ["any"]}], //禁止某些propTypes        "react/jsx-boolean-value": 2, //在JSX中强制布尔属性符号        "react/jsx-closing-bracket-location": 1, //在JSX中验证右括号位置        "react/jsx-curly-spacing": [2, {"when": "never", "children": true}], //在JSX属性和表达式中加强或禁止大括号内的空格。        "react/jsx-indent-props": [2, 4], //验证JSX中的props缩进        "react/jsx-key": 2, //在数组或迭代器中验证JSX具有key属性        "react/jsx-max-props-per-line": [1, {"maximum": 1}], // 限制JSX中单行上的props的最大数量        "react/jsx-no-bind": 0, //JSX中不允许使用箭头函数和bind        "react/jsx-no-duplicate-props": 2, //防止在JSX中重复的props        "react/jsx-no-literals": 0, //防止使用未包装的JSX字符串        "react/jsx-no-undef": 1, //在JSX中禁止未声明的变量        "react/jsx-pascal-case": 0, //为用户定义的JSX组件强制使用PascalCase        "react/jsx-sort-props": 2, //强化props按字母排序        "react/jsx-uses-react": 1, //防止反应被错误地标记为未使用        "react/jsx-uses-vars": 2, //防止在JSX中使用的变量被错误地标记为未使用        "react/no-danger": 0, //防止使用危险的JSX属性        "react/no-did-mount-set-state": 0, //防止在componentDidMount中使用setState        "react/no-did-update-set-state": 1, //防止在componentDidUpdate中使用setState        "react/no-direct-mutation-state": 2, //防止this.state的直接变异        "react/no-multi-comp": 2, //防止每个文件有多个组件定义        "react/no-set-state": 0, //防止使用setState        "react/no-unknown-property": 2, //防止使用未知的DOM属性        "react/prefer-es6-class": 2, //为React组件强制执行ES5或ES6类        "react/prop-types": 0, //防止在React组件定义中丢失props验证        "react/react-in-jsx-scope": 2, //使用JSX时防止丢失React        "react/self-closing-comp": 0, //防止没有children的组件的额外结束标签        "react/sort-comp": 2, //强制组件方法顺序        "no-extra-boolean-cast": 0, //禁止不必要的bool转换        "react/no-array-index-key": 0, //防止在数组中遍历中使用数组key做索引        "react/no-deprecated": 1, //不使用弃用的方法        "react/jsx-equals-spacing": 2, //在JSX属性中强制或禁止等号周围的空格        "no-unreachable": 1, //不能有无法执行的代码        "comma-dangle": 2, //对象字面量项尾不能有逗号        "no-mixed-spaces-and-tabs": 0, //禁止混用tab和空格        "prefer-arrow-callback": 0, //比较喜欢箭头回调        "arrow-parens": 0, //箭头函数用小括号括起来        "arrow-spacing": 0 //=>的前/后括号    }}复制代码
touch .gitigore复制代码
# Mac OS.DS_Store# IDE.idea.project.vscode# npmnode_modulesnpm-debug.logyarn-error.logsrc/exports.tsxexportEntry.jsonlib/components# folderdist# 自动更新目录,不要修改此目录里面的内容.yo-rc.jsondist#缓存sh.sh.cache/tmppackage-lock.json复制代码

接下来新建一个tsconfig.json,这个文件中指定了typescript用来编译这个项目的根文件和编译选项。

touch tsconfig.json复制代码

安装必要的依赖项,注意types定义了react包的声明文件。

npm install react react-dom @types/react @types/react-dom --save复制代码
npm install @types/styled-components @typescript-eslint/eslint-plugin @typescript-eslint/parser awesome-typescript-loader eslint eslint-loader eslint-plugin-react html-webpack-plugin styled-components source-map-loader typescript webpack webpack-cli --save-dev复制代码

项目用styled-components封装组件增加样式,但由于styled-components没有typescrpt声明文件所以我们只能手动声明。

mkdir typings
cd typings
mkdir styled-components
touch styled-components.d.ts
// 文件内容为 declare module 'styled-components';复制代码

初始化webpack入口文件,初始化第一个组件UnButton

touch index.html
mkdir src
cd src
touch index.tsx
touch Layout.tsx
mkdir components
cd components
mkdir UnButton
cd UnButton
touch index.tsx复制代码
  • index.html
  • src
    • component
      • UnButton
        • index.tsx
    • index.tsx
    • Layout.tsx

项目结构看起来是这样的。

index.html:

src/index.tsx

src/layout.tsx

src/components/UnButton/index.tsx

最后创建webpack.config.js文件

执行 webpack-dev-server --mode=development --open

应该能正常弹出网页,表明已经成功用typescript+react开发好了一个components组件UnButton并且在我们的测试文件Layout.tsx中引入成功。

导出发布:

我们一般用的UI框架用法一般都是

import { Button } from 'antd';复制代码

所以我们的包应该是一个导出所有组件的一个入口文件。在src文件夹下新建一个exports.tsx

import UnButton from './components/UnButton'

export {  UnButton}复制代码

在根目录新建一个webpack.export.js文件

一定要在output中增加librarytarget选项,因为webpack打包完是闭包,外部引入不了。

运行

webpack --config webpack.config.js --mode=production

会在根目录生成lib文件夹,我们发布的就是这个文件夹。

完善下package.json文件

main字段为外部import我们npm包的入口文件

files定义我们发布的文件夹

使用

npm login

登录你的npm账号

npm publish

发布到npm仓库中

最后,可以新建一个react项目

npm install unnamedui

就可以快乐的使用我们自己的npm包了

链接:

github地址

我来评几句
登录后评论

已发表评论数()

相关站点

+订阅
热门文章