start
- functional β in all senses
- fast β parallelism and concurrency
- shareable β presets as published packages
- 4th line to align with logo on the right
TOC
Example
.
βββ packages/
β βββ foo/
β β βββ src/
β β β βββ index.ts
β β βββ test/
β β β βββ index.ts
β β βββ package.json
β βββ bar/
β βββ src/
β β βββ index.ts
β βββ test/
β β βββ index.ts
β βββ package.json
βββ package.json
βββ tasks.ts
$ yarn add --dev --ignore-workspace-root-check \
@babel/core \
@babel/register \
@babel/preset-env \
@babel/preset-typescript \
@start/cli \
@start/reporter-verbose \
@start/plugin-sequence \
@start/plugin-parallel \
@start/plugin-xargs \
@start/plugin-find \
@start/plugin-find-git-staged \
@start/plugin-remove \
@start/plugin-read \
@start/plugin-rename \
@start/plugin-write \
@start/plugin-lib-babel \
@start/plugin-lib-typescript-generate \
@start/plugin-lib-eslint \
@start/plugin-lib-istanbul \
@start/plugin-lib-tape \
@start/plugin-lib-codecov
// package.json
{
"private": true,
"description": "Start example",
"workspaces": [
"packages/*"
],
"devDependencies": {},
"start": {
// tasks file, default to `./tasks`
"file": "./tasks"
"require": [
[
"@babel/register",
{
"extensions": [
".ts",
".js"
]
}
]
],
"reporter": "@start/reporter-verbose"
},
"babel": {
"presets": [
[
"@babel/preset-env",
{
"targets": {
"node": "current"
}
}
],
// Babel 7
"@babel/preset-typescript"
]
}
}
// tasks.ts
// write tasks file once, publish it and then reuse or even extend
// in all projects using `start.preset` option in `package.json`,
// something like `my-start-preset` package with everything included
import sequence from '@start/plugin-sequence'
import parallel from '@start/plugin-parallel'
import xargs from '@start/plugin-xargs'
import find from '@start/plugin-find'
import findGitStaged from '@start/plugin-find-git-staged'
import remove from '@start/plugin-remove'
import read from '@start/plugin-read'
import rename from '@start/plugin-rename'
import write from '@start/plugin-write'
import babel from '@start/plugin-lib-babel'
import typescriptGenerate from '@start/plugin-lib-typescript-generate'
import eslint from '@start/plugin-lib-eslint'
import {
istanbulInstrument,
istanbulReport,
istanbulThresholds
} from '@start/plugin-lib-istanbul'
import tape from '@start/plugin-lib-tape'
import codecov from '@start/plugin-lib-codecov'
const babelConfig = {
babelrc: false,
presets: [
[
'@babel/preset-env',
{
targets: {
node: 6
},
modules: false
}
],
'@babel/preset-typescript'
]
}
// each named export is a "task"
export const build = (packageName: string) =>
sequence(
find(`packages/${packageName}/src/**/*.ts`),
read,
babel(babelConfig),
rename((file) => file.replace(/\.ts$/, '.js')),
write(`packages/${packageName}/build/`)
)
export const dts = (packageName: string) =>
sequence(
find(`packages/${packageName}/src/index.ts`),
typescriptGenerate(`packages/${packageName}/build/`)
)
export const pack = (packageName: string) =>
sequence(
find(`packages/${packageName}/build/`),
remove,
// child-processes
parallel(['build', 'dts'])(packageName)
)
// child processes
export const packs = xargs('pack')
export const dev = (packageName: string) =>
watch(`packages/${packageName}/**/*.ts`)(
build(packageName)
)
export const lint = () =>
sequence(
findGitStaged(['packages/*/{src,test}/**/*.ts']),
read,
eslint()
)
export const lintAll = () =>
sequence(
find(['packages/*/{src,test}/**/*.ts']),
read,
eslint()
)
export const test = () =>
sequence(
find('coverage/'),
remove,
find('packages/*/src/**/*.ts'),
istanbulInstrument({ esModules: true, extensions: ['.ts'] }),
find('packages/*/test/**/*.ts'),
tape(),
istanbulReport(['lcovonly', 'html', 'text-summary']),
istanbulThresholds({ functions: 100 })
)
export const ci = () =>
sequence(
// nested task
lintAll(),
// nested task
test(),
find('coverage/lcov.info'),
read,
codecov
)
$ yarn start
# or
$ npx start
One of the following task names is required:
* build
* dts
* pack
* packs
* dev
* lint
* lintAll
* test
* ci
$ yarn start build foo
$ yarn start dts foo
$ yarn start pack foo
$ yarn start packs foo bar
$ yarn start dev bar
$ yarn start lint
$ yarn start lintAll
$ yarn start test
$ yarn start ci
How to
Recipes
- Node.js TypeScript library preset β @deepsweet/start-preset-node-ts-lib
- Node.js TypeScript libraries monorepo β Start project builds itself from sources using sources, see
tasks/index.ts
- React / React Native (higher-order) components monorepo β hocs
- React app β to be added
Packages
Core
-
β¬οΈ cli β CLI entry point -
βοΈ plugin β plugin creator -
π reporter-verbose β verbose reporter
Plugins
Misc
-
β© plugin-sequence β run plugins in sequence -
π plugin-parallel β run tasks as parallel child processes with same agruments -
π plugin-xargs β run task as parallel child process for each argument -
π£ plugin-spawn β spawn new child process -
π plugin-env β set environment variable usingprocess.env
-
π plugin-input-files β inject arguments as files into Start flow files -
π plugin-output-files β to be added
FS
-
π plugin-find β find files using glob patterns -
π plugin-find-git-staged β find Git staged files and filter them using glob patterns -
π plugin-read β read files content -
π plugin-rename β rename files -
β plugin-remove β remove files or directories -
π― plugin-copy β copy files to relative destination using streams and keeping folders structure -
βοΈ plugin-write β write files with source maps to relative destination keeping folders structure -
βοΈ plugin-overwrite β overwrite files -
π plugin-watch β watch for new or changed files matched by glob patterns -
π plugin-unpack β unpack .tar/.tar.bz2/.tar.gz/.zip archives
Build and bundle
-
π plugin-lib-babel β transform files using Babel -
π plugin-lib-esm-loader β copy a predefined ESM loader file to a directory -
π plugin-lib-webpack β bundle files using Webpack -
π plugin-lib-webpack-dev-server β run Webpack development server -
π plugin-lib-rollup β bundle files using Rollup -
π plugin-lib-typescript-generate β generate.d.ts
files using TypeScript -
π plugin-lib-flow-generate β generate.js.flow
files using Flow -
π plugin-lib-postcss β transform files using PostCSS -
π plugin-lib-less β to be migrated -
π plugin-lib-clean-css β to be migrated -
π plugin-lib-uglify β to be migrated
Tests
-
β plugin-lib-jest βΒ run tests using Jest -
β plugin-lib-tape β run tests using Tape -
β plugin-lib-karma β run tests using Karma -
π― plugin-lib-instanbul β collect, report and check code coverage using Istanbul -
β plugin-lib-ava β to be migrated -
β plugin-lib-mocha β to be migrated -
β plugin-assert βΒ Node.jsassert()
Lint, check and fix
-
π· plugin-lib-eslint β lint and/or fix code using ESLint -
π· plugin-lib-prettier-eslint β fix code(style) using Prettier + ESLint -
π· plugin-lib-typescript-check βΒ check types using TypeScript -
π· plugin-lib-flow-check β check types using Flow
CI and publish
-
π― plugin-lib-codecov β send code coverage report to codecov.io -
π’ plugin-lib-npm-version β bump package version -
π¦ plugin-lib-npm-publish βΒ publish package to NPM -
π― plugin-lib-coveralls β to be migrated
Tasks
Coming soon.
Roadmap
- stabilize and publish 0.1.0 of everything
- documentation
- more tests
- migrate the rest of important plugins
Copyright
All the packages in this repository are released under the terms of the MIT License.
The font used in logo is supernova fat.