Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tradeshift/tradeshift-scripts

Build tooling for tradeshift npm packages
https://github.com/tradeshift/tradeshift-scripts

developer-productivity javascript npm tradeshift

Last synced: about 1 month ago
JSON representation

Build tooling for tradeshift npm packages

Awesome Lists containing this project

README 

        


tradeshift-scripts 🛠📦



Making `npm init` "gg ez"








[![Build Status][build-badge]][build]

[![Code Coverage][coverage-badge]][coverage]

[![version][version-badge]][package]

[![downloads][downloads-badge]][npmcharts]

[![MIT License][license-badge]][license]



[![PRs Welcome][prs-badge]][prs]

[![Code of Conduct][coc-badge]][coc]



## The problem



[![Greenkeeper badge](https://badges.greenkeeper.io/tradeshift/tradeshift-scripts.svg)](https://greenkeeper.io/)



Creating new tradeshift npm libraries requires a lot of boilerplate configuration,

and is prone to errors. Configurations will often diverge or never be updated.



## This solution



This is a CLI that abstracts away all configuration for open source projects

for linting, testing, building, and more.



## Table of Contents



- [Installation](#installation)

- [Usage](#usage)

- [Inspiration](#inspiration)

- [Other Solutions](#other-solutions)

- [LICENSE](#license)



## Installation



This module is distributed via [npm][npm] which is bundled with [node][node] and

should be installed as one of your project's `devDependencies`:



```

npm install --save-dev tradeshift-scripts

```



> Note: for now, you'll have to include an `.eslintignore` in your project until

> [this eslint issue is resolved](https://github.com/eslint/eslint/issues/9227).



## Usage



This is a CLI and exposes a bin called `tradeshift-scripts`.



This project actually dogfoods itself. If you look in the `package.json`, you'll

find scripts with `node src {scriptName}`. This serves as an example of some

of the things you can do with `tradeshift-scripts`.



To use the `after-success` hooks and automatic [semantic release][semantic-release],

you need to set up your build env with `GH_TOKEN` and `NPM_TOKEN`.



If you want to automatically publish coverage reports to [codecov][codecov], add

a `CODECOV_TOKEN`.



Example `package.json`



```json

{

	"name": "awesome-library",

	"version": "0.0.0-semantically-released",

	"main": "dist/index.js",

	"files": ["dist"],

	"scripts": {

		"test": "tradeshift-scripts test",

		"test:update": "tradeshift-scripts test --updateSnapshot",

		"build": "tradeshift-scripts build",

		"lint": "tradeshift-scripts lint",

		"format": "tradeshift-scripts format",

		"validate": "tradeshift-scripts validate",

		"precommit": "tradeshift-scripts precommit",

		"after-success": "tradeshift-scripts travis-after-success"

	},

	"devDependencies": {

		"tradeshift-scripts": "1.1.0"

	}

}

```



Example `.travis.yml`



```yaml

sudo: false

language: node_js

cache:

  directories:

    - node_modules

notifications:

  email: false

node_js:

  - '8'

script: npm run validate

after_success:

  - npm run after-success

branches:

  only:

    - master

```



### Overriding Config



Unlike `react-scripts`, `tradeshift-scripts` allows you to specify your own

configuration for things and have that plug directly into the way things work

with `tradeshift-scripts`. There are various ways that it works, but basically if you

want to have your own config for something, just add the configuration and

`tradeshift-scripts` will use that instead of it's own internal config. In addition,

`tradeshift-scripts` exposes its configuration so you can use it and override only

the parts of the config you need to.



This can be a very helpful way to make _editor integration_ work for tools like

ESLint which require project-based ESLint configuration to be present to work.



So, if we were to do this for ESLint, you could create an `.eslintrc` with the

contents of:



```

{"extends": "./node_modules/tradeshift-scripts/eslint.js"}

```



Or, for `babel`, a `.babelrc` with:



```

{"presets": ["tradeshift-scripts/babel"]}

```



Or, for `jest`:



```javascript

const { jest: jestConfig } = require('tradeshift-scripts/config');

module.exports = Object.assign(jestConfig, {

	// your overrides here

});

```



> Note: `tradeshift-scripts` intentionally does not merge things for you when you start

> configuring things to make it less magical and more straightforward. Extending

> can take place on your terms. I think this is actually a great way to do this.



## Inspiration



This is inspired by `react-scripts`.



## Other Solutions



`tradeshift-scripts` is a fork of [kcd-scripts][kcd], adapted to tradeshift.



## LICENSE



MIT



[npm]: https://www.npmjs.com/

[node]: https://nodejs.org

[build-badge]: https://img.shields.io/travis/tradeshift/tradeshift-scripts.svg?style=flat-square

[build]: https://travis-ci.org/tradeshift/tradeshift-scripts

[coverage-badge]: https://img.shields.io/codecov/c/github/tradeshift/tradeshift-scripts.svg?style=flat-square

[coverage]: https://codecov.io/github/tradeshift/tradeshift-scripts

[version-badge]: https://img.shields.io/npm/v/tradeshift-scripts.svg?style=flat-square

[package]: https://www.npmjs.com/package/tradeshift-scripts

[downloads-badge]: https://img.shields.io/npm/dm/tradeshift-scripts.svg?style=flat-square

[npmcharts]: http://npmcharts.com/compare/tradeshift-scripts

[license-badge]: https://img.shields.io/npm/l/tradeshift-scripts.svg?style=flat-square

[license]: https://github.com/tradeshift/tradeshift-scripts/blob/master/LICENSE

[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square

[prs]: http://makeapullrequest.com

[donate-badge]: https://img.shields.io/badge/$-support-green.svg?style=flat-square

[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square

[coc]: https://github.com/tradeshift/tradeshift-scripts/blob/master/other/CODE_OF_CONDUCT.md

[twitter]: https://twitter.com/intent/tweet?text=Check%20out%20tradeshift-scripts!%20https://github.com/tradeshift/tradeshift-scripts%20%F0%9F%91%8D

[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/tradeshift/tradeshift-scripts.svg?style=social

[kcd]: https://github.com/kentcdodds/kcd-scripts

[semantic-release]: https://github.com/semantic-release/semantic-release

[codecov]: https://codecov.io