SoorajSNBlaze333 / js-npm-template

✨✨✨JS发布JS NPM包模板，包括 Rollup，Husky，Eslint，Prettier，Travis，Babel，EditorConfig，BrowserLint等等🔥🔥🔥

Javascript Npm Template

关于该库的一些简单介绍，比如作用，依赖等等

一些其他提示和备注.（可选）

⭐️ Features

• 使用 typescript 编写，提供更好的代码提示和类型检查
• 包体积更小，轻量无依赖

📦 Getting Started

install

# npm 
npm install --save lib

# yarn
yarn add lib

usage

参数配置如下：

Option	Type	Description
param1	string	intro param
param1	string	intro param
param1	string	intro param
param1	array	intro param
param1	string	intro param

import utils from lib

utils()

For more examples, please refer to the Documentation

✨ Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

⚙️ Changelog

See CHANGELOG

LICENSE

MIT

✈️ TODO

• todo

---

下面主要是该模板存在的一些配置文件信息，实际开发中直接在README删除。

template included

• babelrc (主要用于将 ECMAScript 2015+ 版本的代码转换为向后兼容的 JavaScript 语法，以便能够运行在当前和旧版本的浏览器或其他环境中)
• editorconfig (定义和维护跨编辑器（或IDE）的统一的代码风格)
• browserslistrc (在不同的前端工具之间共用目标浏览器和 node 版本的配置工具)
• prettier (代码格式化，对具体的语法有具体的格式化方案)
• eslint (提供一个插件化的javascript代码检测工具)
• gitignore
• commitlint (git commit lint)
• huskyrc (git 提交之前的格式化与检查)
• README (lib info)
• LICENSE
• .travis.yml (travis)
• npmrc
• CHANGELOG
• git author (检测用户提交账号)

备注

@babel/runtime-corejs3 导入会导致包体积变大，如果没有必要，直接删除即可，并更改 babel 配置