60

发起一个github/npm工程协作项目,门槛太高了!!

最基础的问题,你都要花很久去研究:

  • 如何在项目中全线使用es2017代码? 答案是babel
  • 如何统一所有协作者的代码风格? 答案是eslint + prettier
  • 如何测试驱动开发,让项目更健壮? 答案是jest
  • 如何持续化集成,方便更多协作者参与项目? 答案是circleci

这四样工具的配置,是每个github项目都会用上的。另外,gitignore配置、editconfig、readme、lisence。。。也是必不可缺的。

你可能需要花数天时间去研究文档、数天时间去做基础配置。

这样的时间成本,可以直接劝退大多数人。

但,假如几秒钟,就可以按需求配置好这一切呢?

你可以先来体验一下“轮子工厂”,在命令行输入:

npx lunz myapp

一路回车,然后试一试yarn lintyarn testyarn build命令


第一部分: 2019年github + npm工程化协作开发栈最佳实践

第二部分: 使用脚手架,10秒钟构建可自由配置的开发栈。


2019年github + npm工程化协作开发栈最佳实践

我们将花半小时实战撸一个包含package.json, babel, jest, eslint, prettify, gitignore, readme, lisence的标准的用于github工程协作的npm包开发栈

如果能实际操作,请实际操作。

如果不能实际操作,请在bash下输入npx lunz npmdev获得同样的效果。

1. 新建文件夹

mkdir npmdev && cd npmdev

2. 初始化package.json

npm init
package name: 回车

version: 回车

description: 自己瞎写一个,不填也行

entry point:  输入`dist/index.js`

test command: 输入`jest`

git repository: 输入你的英文名加上包名,例如`wanthering/npmdev`

keywords: 自己瞎写一个,不填也行

author: 你的英文名,例如`wanthering`

license: 输入`MIT`

在package.json中添加files字段,使npm发包时只发布dist

  ...
  "files": ["dist"],
  ...

之前不是创建了.editorconfigLICENSEcircle.yml.gitignoreREADME.md吗,这四个复制过来。

3. 初始化eslint

npx eslint --init
How would you like to use ESLint? 选第三个

What type of modules does your project use? 
选第一个

Which framework does your project use?
选第三个None

Where does your code run?
选第二个 Node

How would you like to define a style for your project? 选第一个popular

Which style guide do you want to follow?
选第一个standard

What format do you want your config file to be in?
选第一个 javascript

在package.json中添加一条srcipts命令:

   ...
  "scripts": {
    "test": "jest",
    "lint": "eslint src/**/*.js test/**/*.js --fix"
  },
  ...

4. 初始化prettier

为了兼容eslint,需要安装三个包

yarn add prettier eslint-plugin-prettier eslint-config-prettier -D

在package.json中添加prettier字段

  ...
  "prettier": {
    "singleQuote": true,
    "semi": false
  },
  ...

在.eslintrc.js中,修改extends字段:

...
  'extends': ['standard',"prettier","plugin:prettier/recommended"],
...

5. 创建源文件

mkdir src && touch src/index.js

src/index.js中,我们用最简单的add函数做示意

const add = (a,b)=>{
return a+b}
    export default add

这时命令行输入

yarn lint

这会看到index.js自动排齐成了

const add = (a, b) => {
  return a + b
}
export default add

6. 配置jest文件

所有的npm包,均采用测试驱动开发。

现在流行的框架,无非jest和ava,其它的mocha之类的框架已经死在沙滩上了。

我们安装jest

npm i jest -D

然后根目录下新建一个test文件夹,放置进jest/index.spec.js文件

mkdir test && touch test/index.spec.js

在index.spec.js内写入:

import add from "../src/index.js";
test('add',()=>{
expect(add(1,2)).toBe(3)})

配置一下eslint+jest:

yarn add eslint-plugin-jest -D

在.eslintrc.js中,更新env字段,添加plugins字段:

  'env': {
    'es6': true,
    'node': true,
    'jest/globals': true
  },
  'plugins': ['jest'],
 ...

因为需要jest中使用es6语句,需要添加babel支持

yarn add babel-jest @babel/core @babel/preset-env -D

创建一下.babelrc配置,注意test字段,是专门为了转化测试文件的:

{
  "presets": [
    [
      "@babel/preset-env",
      {
        "targets": {
          "node": 6
        }
      }
    ]
  ],
  "env": {
    "test": {
      "presets": [
        [
          "@babel/preset-env",
          {
            "targets": {
              "node": "current"
            }
          }
        ]
      ]
    }
  }
}

好,跑一下yarn lint,以及yarn test

yarn lint

yarn test

构建打包

比起使用babel转码(安装@babel/cli,再调用npx babel src --out-dir dist),我更倾向于使用bili进行打包。

yarn add bili -D

然后在package.json的script中添加

  "scripts": {
    "test": "jest",
    "lint": "eslint src/**/*.js test/**/*.js --fix",
    "build": "bili"
  },

.gitignore

创建 .gitignore,复制以下内容到文件里

node_modules
.DS_Store
.idea
*.log
dist
output
examples/*/yarn.lock

.editorconfig

创建.editorconfig,复制以下内容到文件里

root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false

circle.yml

创建circle.yml,复制以下内容到文件内

version: 2
jobs:
  build:
    working_directory: ~/project
    docker:
      - image: circleci/node:latest
    branches:
      ignore:
        - gh-pages # list of branches to ignore
        - /release\/.*/ # or ignore regexes
    steps:
      - checkout
      - restore_cache:
          key: dependency-cache-{{ checksum "yarn.lock" }}
      - run:
          name: install dependences
          command: yarn install
      - save_cache:
          key: dependency-cache-{{ checksum "yarn.lock" }}
          paths:
            - ./node_modules
      - run:
          name: test
          command: yarn test

README.md

创建README.md,复制以下内容到文件内

# npm-dev

> my laudable project

好了,现在我们的用于github工程协作的npm包开发栈已经完成了,相信我,你不会想再配置一次。

这个项目告一段落。

事实上,这个npm包用npm publish发布出去,人们在安装它之后,可以作为add函数在项目里使用。

使用脚手架,10秒钟构建可自由配置的开发栈。

同样,这一章节如果没时间实际操作,请输入

git clone https://github.com/wanthering/lunz.git

当你开启新项目,复制粘贴以前的配置和目录结构,浪费时间且容易出错。

package.json、webpack、jest、git、eslint、circleci、prettify、babel、gitigonre、editconfig、readme的强势劝退组合,让你无路可走。

所以有了vue-cli,非常强大的脚手架工具,但你想自定义自己的脚手架,你必须学透了vue-cli。

以及yeoman,配置贼麻烦,最智障的前端工具,谁用谁sb。

还有人求助于docker,

有幸,一位来自成都的宝藏少年egoist开发了前端工具SAO.js。

SAO背景不错,是nuxt.js的官方脚手架。

作为vue的亲弟弟nuxt,不用vue-cli反而用sao.js,你懂意思吧?

因为爽!!!!!!!!

因为,一旦你学会批量构建npm包,未来将可以把精力集中在“造轮子”上。

新建sao.js

全局安装

npm i sao -g

快速创建sao模板

sao generator sao-npm-dev

一路回车到底

ok,当前目录下出现了一个sao-npm-dev

打开看一下:

├── .editorconfig
├── .git
├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
├── circle.yml
├── package.json
├── saofile.js
├── template
│   ├── .editorconfig
│   ├── .gitattributes
│   ├── LICENSE
│   ├── README.md
│   └── gitignore
├── test
│   └── test.js
└── yarn.lock

别管其它文件,都是用于github工程协作的文件。

有用的只有两个:template文件夹, 和saofile.js

template文件夹删空,我们要放自己的文件。

生成SAO脚手架

好,把npmdev整个文件夹内的内容,除了node_modules/、package-lock.json和dist/,全部拷贝到清空的sao-npm-dev/template/文件夹下

现在的sao-npm-dev/template文件夹结构如下:

├── template
│   ├── .babelrc
│   ├── .editorconfig
│   ├── .eslintrc.js
│   ├── .gitignore
│   ├── LICENSE
│   ├── README.md
│   ├── circle.yml
│   ├── package.json
│   ├── src
│   │   └── index.js
│   ├── test
│   │   └── index.spec.js
│   └── yarn.lock

配置文件改名

模板文件中.eslint.js .babelrc .gitignore package.json,很容易造成配置冲突,我们先改名使它们失效:

mv .eslintrc.js _.eslintrc.js

mv .babelrc _.babelrc

mv .gitignore _gitignore

mv package.json _package.json

配置saofile.js

现在所见的saofile,由三部分组成: prompts, actions, completed。

分别表示: 询问弹窗、自动执行任务、执行任务后操作。

大家可以回忆一下vue-cli的创建流程,基本上也是这三个步骤。

弹窗询问的,即是我们用于github工程协作的npm包开发栈每次开发时的变量,有哪些呢?

我来列一张表:

字段 输入方式 可选值 意义
name input 默认为文件夹名 项目名称
description input 默认为my xxx project 项目简介
author input 默认为gituser 作者名
features checkbox eslint和prettier 安装插件
test confirm yes 和no 是否测试
build choose babel 和 bili 选择打包方式
pm choose npm 和yarn 包管理器

根据这张表,我们修改一下saofile.js中的prompts,并且新增一个templateData(){},用于向template中引入其它变量

   prompts() {
    return [
      {
        name: 'name',
        message: 'What is the name of the new project',
        default: this.outFolder
      },
      {
        name: 'description',
        message: 'How would you descripe the new project',
        default: `my ${superb()} project`
      },
      {
        name: 'author',
        message: 'What is your GitHub username',
        default: this.gitUser.username || this.gitUser.name,
        store: true
      },
      {
        name: 'features',
        message: 'Choose features to install',
        type: 'checkbox',
        choices: [
          {
            name: 'Linter / Formatter',
            value: 'linter'
          },
          {
            name: 'Prettier',
            value: 'prettier'
          }
        ],
        default: ['linter', 'prettier']
      },
      {
        name: 'test',
        message: 'Use jest as test framework?',
        type: 'confirm',
        default: true
      },
      {
        name: 'build',
        message: "How to bundle your Files?",
        choices: ['bili', 'babel'],
        type: 'list',
        default: 'bili'
      },
      {
        name: 'pm',
        message: 'Choose a package manager',
        choices: ['npm', 'yarn'],
        type: 'list',
        default: 'yarn'
      }
    ]
  },
  templateData() {
    const linter = this.answers.features.includes('linter')
    const prettier = this.answers.features.includes('prettier')
    return {
      linter, prettier
    }
  },

先把saofile放下,我们去修改一下template文件,使template中的文件可以应用这些变量

修改template/中的变量

template下的文件,引入变量的方式是ejs方式,不熟悉的可以看一看ejs官方页面,非常简单的一个模板引擎

现在我们一个一个审视文件,看哪些文件需要根据变量变动。

1. src/index.js

无需变动

2. test/index.spec.js

如果test为false,则文件无需加载。test为true,则加载文件。

3. .editorconfig

无需改动

4. _.gitignore

无需改动

5. _.babelrc

如果build采用的babel,或test为true,则导入文件。

并且,如果test为true,应当开启env,如下设置文件

_.babelrc

{
  "presets": [
    [
      "@babel/preset-env",
      {
        "targets": {
          "node": 6
        }
      }
    ]
  ]<% if( test ) { %>,
  "env": {
    "test": {
      "presets": [
        [
          "@babel/preset-env",
          {
            "targets": {
              "node": "current"
            }
          }
        ]
      ]
    }
  }<% } %>
}

6. _.eslintrc.js

在打开test的情况下,加载env下的jest/globals及设置plugins下的jest

在开启prettier的情况下,加载extends下的prettierplugin:prettier/recommend

所以文件应当这样改写

_.eslintrc.js

module.exports = {
  'env': {
    'es6': true,
    'node': true<% if(test) { %>,
    'jest/globals': true<% } %>
  }<% if(test) { %>,
 'plugins': ['jest']<% } %>,
  'extends': ['standard'<% if(prettier) { %>,'prettier','plugin:prettier/recommended'<% } %>],
  'globals': {
    'Atomics': 'readonly',
    'SharedArrayBuffer': 'readonly'
  },
  'parserOptions': {
    'ecmaVersion': 2018,
    'sourceType': 'module'
  }
}

7. _package.json

name字段,加载name变量
description字段,加载description变量
author字段,加载author变量

bugs,homepage,url跟据author和name设置

prettier为true时,设置prettier字段,以及devDependence加载eslint-plugin-prettier、eslint-config-prettier以及prettier

eslint为true时,加载eslint下的其它依赖。

jest为true时,加载eslint-plugin-jest、babel-jest、@babel/core和@babel/preset-env,且设置scripts下的lint语句

build为bili时,设置scripts下的build字段为bili

build为babel时,设置scripts下的build字段为babel src --out-dir dist

最后实际的文件为:(注意里面的ejs判断语句)

{
  "name": "<%= name %>",
  "version": "1.0.0",
  "description": "<%= description %>",
  "main": "dist/index.js",
  "scripts": {
    "build": "<% if(build === 'bili') { %>bili<% }else{ %>babel src --out-dir dist<% } %>"<% if(test){ %>,
    "test": "jest"<% } %><% if(linter){ %>,
    "lint": "eslint src/**/*.js<% } if(linter && test){ %> test/**/*.js<% } if(linter){ %> --fix"<% } %>
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/<%= author %>/<%= name %>.git"
  },
  "author": "<%= author %>",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/<%= author %>/<%= name %>/issues"
  }<% if(prettier){ %>,
  "prettier": {
    "singleQuote": true,
    "semi": false
  }<% } %>,
  "homepage": "https://github.com/<%= author %>/<%= name %>#readme",
  "devDependencies": {
    <% if(build === 'bili'){ %>
    "bili": "^4.7.4"<% } %><% if(build === 'babel'){ %>
    "@babel/cli": "^7.4.4"<% } %><% if(build === 'babel' || test){ %>,
    "@babel/core": "^7.4.4",
    "@babel/preset-env": "^7.4.4"<% } %><% if(test){ %>,
    "babel-jest": "^24.8.0",
    "jest": "^24.8.0"<% } %><% if(linter){ %>,
    "eslint": "^5.16.0",
    "eslint-config-standard": "^12.0.0",
    "eslint-plugin-import": "^2.17.2",
    "eslint-plugin-node": "^9.0.1",
    "eslint-plugin-promise": "^4.1.1",
    "eslint-plugin-standard": "^4.0.0"<% } %><% if(linter && test){ %>,
    "eslint-plugin-jest": "^22.5.1"<% } %><% if (prettier){ %>,
    "prettier": "^1.17.0",
    "eslint-plugin-prettier": "^3.1.0",
    "eslint-config-prettier": "^4.2.0"<% } %>
  }
}

8. circle.yml

判断使用的lockFile文件是yarn.lock还是package-lock.json

<% const lockFile = pm === 'yarn' ? 'yarn.lock' : 'package-lock.json' -%>
version: 2
jobs:
  build:
    working_directory: ~/project
    docker:
      - image: circleci/node:latest
    branches:
      ignore:
        - gh-pages # list of branches to ignore
        - /release\/.*/ # or ignore regexes
    steps:
      - checkout
      - restore_cache:
          key: dependency-cache-{{ checksum "<%= lockFile %>" }}
      - run:
          name: install dependences
          command: <%= pm %> install
      - save_cache:
          key: dependency-cache-{{ checksum "<%= lockFile %>" }}
          paths:
            - ./node_modules
      - run:
          name: test
          command: <%= pm %> test

9. README.md

# <%= name %>

> <%= description %>

填入name和desc变量。

并跟据linter、test、build变量来选择提示命令。

具体文件略。


好,文件的变量导入完成,现在回到saofile.js:

处理actions

当我们通过弹窗询问到了变量。

当我们在构建好模板文件,只等变量导入了。

现在就需要通过saofile.js中的actions进行导入。

把actions进行如下改写:

  actions() {
    return [{
      type: 'add',
      files: '**',
      filters: {
        '_.babelrc': this.answers.test || this.answers.build === 'babel',
        '_.eslintrc.js': this.answers.features.includes('linter'),
        'test/**': this.answers.test
      }
    }, {
      type: 'move',
      patterns: {
        '_package.json': 'package.json',
        '_gitignore': '.gitignore',
        '_.eslintrc.js': '.eslintrc.js',
        '_.babelrc': '.babelrc'
      }
    }]
  },

其实很好理解! type:'add'表示将模板文件添加到目标文件夹下,files表示是所有的, filters表示以下这三个文件存在的条件。

type:'move'就是改名或移动的意思,将之前加了下划线的四个文件,改回原来的名字。

处理competed

当文件操作处理完之后,我们还需要做如下操作:

  1. 初始化git
  2. 安装package里的依赖
  3. 输出使用指南
  async completed() {
    this.gitInit()
    await this.npmInstall({ npmClient: this.answers.pm })
    this.showProjectTips()
  }

跑通测试

SAO已经帮你写好了测试文件,在test文件夹下。

因为我们要测试很多个选项,原来的sao.mock和snapshot要写很多次。所以我们把它提炼成一个新的函数verifyPkg()

我们进行一下改写,同时将package.json、.eslintrc.js打印在snapshot文件中。

import path from 'path'
import test from 'ava'
import sao from 'sao'

const generator = path.join(__dirname, '..')

const verifyPkg = async (t, answers) => {
  const stream = await sao.mock({ generator }, answers)
  const pkg = await stream.readFile('package.json')
  t.snapshot(stream.fileList, 'Generated files')
  t.snapshot(getPkgFields(pkg), 'package.json')

  if(answers && answers.features.includes('linter')){
    const lintFile = await stream.readFile('.eslintrc.js')
    t.snapshot(lintFile, '.eslintrc.js')
  }
}

const getPkgFields = (pkg) => {
  pkg = JSON.parse(pkg)
  delete pkg.description
  return pkg
}

test('defaults', async t => {
  await verifyPkg(t)
})

test('only bili', async t => {
  await verifyPkg(t,{
    features: [],
    test: false,
    build: 'bili'
  })
})

test('only babel', async t => {
  await verifyPkg(t,{
    features: [],
    test: false,
    build: 'babel'
  })
})

test('launch test', async t => {
  await verifyPkg(t,{
    features: [],
    test: true
  })
})

test('launch linter', async t => {
  await verifyPkg(t,{
    features: ['linter']
  })
})


test('launch prettier', async t => {
  await verifyPkg(t,{
    features: ['prettier']
  })
})

ok,这时候跑一下测试就跑通了
测试文件打印在snapshots/test.js.md中,你需要一项一项检查,输入不同变量时候,得到的文件结构和package.json 以及.eslintrc.js的内容。

这个时候,整个项目也就完成了。

我们先在npmjs.com下注册一个帐号,登录一下npm login登录一下。

然后,直接npm publish成功之后,就可以使用

sao npm-dev myapp

初始化一个github工程化协作开发栈了。

进阶: 本地使用sao.js,发布自定义前端工具

大部分人,不会专门去安装sao之后再调用脚手架,而更喜欢使用

npx lunz myapp

那就新添加一个cli.js文件

#!/usr/bin/env node
const path = require('path')
const sao = require('sao')

const generator = path.resolve(__dirname, './')
const outDir = path.resolve(process.argv[2] || '.')

console.log(`> Generating lunz in ${outDir}`)

sao({ generator, outDir, logLevel: 2 })
  .run()
  .catch((err) => {
    console.trace(err)
    process.exit(1)
  })

通过sao函数,可以轻松调用于来sao脚手架。

然后,将package.json中的name改名成你想发布npm全局工具名称,比如我创建的是lunz

并且,加入bin字段,且修改files字段

...
  "bin": "cli.js",
  "files": [
  "cli.js",
  "saofile.js",
  "template"
  ],
  ...

这时,应用一下npm link命令,就可以本地模拟出

lunz myapp

的效果了。

如果效果ok的话,就可以使用npm publish发包。

注意要先登录,登录不上的话可能是因为你处在淘宝源下,请切换到npm正版源。

image

结语:

现在,你有什么想法,只需要随时随刻 npx lunz myapp一下,就可以得到当前最新、最标准、最现代化的github+npm工程化实践。

把时间集中花在轮子的构建逻辑上,而不是基础配置上。

与前端之“神”并肩,通过你的经验,让前端的生态更繁荣。

如果实在想研究基础配置,不如帮助我完善这个“轮子工厂”

欢迎大家提交pull request,交最新的实践整合到项目中

github地址: https://github.com/wanthering...

一起加入,构造更完美的最佳实佳!

  1. 点击右上角的Fork按钮。
  2. 新建一个分支:git checkout -b my-new-feature
  3. 上报你的更新:git commit -am 'Add some feature'
  4. 分支上传云端:git push origin my-new-feature
  5. 提交 pull request😘

你可能感兴趣的

10 条评论
madRain · 5月14日

看完之后觉得自己离大神更远了

+1 回复

Trim21 · 5月15日

scripts里面的eslint为什么还要加npx?
在scripts字段中运行命令的时候npm应该自动就会把node_moduels/.bin/加入path吧

+1 回复

0

我核实一下喔

刘羽冲 作者 · 5月15日
0
Trim21 · 5月15日
0

@Trim21 好 我马上更新改了

刘羽冲 作者 · 5月15日
大白 · 5月14日

你好,这边我是通过npm run lint来执行的,可是会报一些很奇怪的错误,你这边是跟yarn来执行有关吗

回复

0

很可能和版本相关,我查看一下。

刘羽冲 作者 · 5月14日
0

摆脱告诉我你的执行环境 然后提issue吧 我看如何报错处理

刘羽冲 作者 · 5月14日
AimLuo · 5月14日

这些配置都是一名合格的前端绕不过去的坎

回复

0

花费的时间和重复 太多啦。

如果自己配置的话 即使很熟练 也要写至少一个上午吧

刘羽冲 作者 · 5月14日
载入中...