{"id":20994129,"url":"https://github.com/tradeshift/tradeshift-scripts","last_synced_at":"2025-05-14T21:30:42.141Z","repository":{"id":34863421,"uuid":"134904758","full_name":"Tradeshift/tradeshift-scripts","owner":"Tradeshift","description":"Build tooling for tradeshift npm packages","archived":false,"fork":false,"pushed_at":"2025-04-25T18:23:08.000Z","size":3327,"stargazers_count":3,"open_issues_count":7,"forks_count":19,"subscribers_count":35,"default_branch":"master","last_synced_at":"2025-04-25T19:29:13.617Z","etag":null,"topics":["developer-productivity","javascript","npm","tradeshift"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Tradeshift.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2018-05-25T21:05:55.000Z","updated_at":"2025-04-01T10:11:41.000Z","dependencies_parsed_at":"2023-11-29T19:27:59.805Z","dependency_job_id":"e173372a-a985-4c46-bad7-9f0a45f922f1","html_url":"https://github.com/Tradeshift/tradeshift-scripts","commit_stats":{"total_commits":305,"total_committers":22,"mean_commits":"13.863636363636363","dds":0.6459016393442623,"last_synced_commit":"1d9ed5c615547641381fc3a165b70982018d924a"},"previous_names":[],"tags_count":222,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tradeshift%2Ftradeshift-scripts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tradeshift%2Ftradeshift-scripts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tradeshift%2Ftradeshift-scripts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tradeshift%2Ftradeshift-scripts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Tradeshift","download_url":"https://codeload.github.com/Tradeshift/tradeshift-scripts/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254230746,"owners_count":22036230,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["developer-productivity","javascript","npm","tradeshift"],"created_at":"2024-11-19T07:16:59.317Z","updated_at":"2025-05-14T21:30:40.763Z","avatar_url":"https://github.com/Tradeshift.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003ch1\u003etradeshift-scripts 🛠📦\u003c/h1\u003e\n\n\u003cp\u003eMaking `npm init` \"gg ez\"\u003c/p\u003e\n\u003c/div\u003e\n\n\u003chr /\u003e\n\n[![Build Status][build-badge]][build]\n[![Code Coverage][coverage-badge]][coverage]\n[![version][version-badge]][package]\n[![downloads][downloads-badge]][npmcharts]\n[![MIT License][license-badge]][license]\n\n[![PRs Welcome][prs-badge]][prs]\n[![Code of Conduct][coc-badge]][coc]\n\n## The problem\n\n[![Greenkeeper badge](https://badges.greenkeeper.io/tradeshift/tradeshift-scripts.svg)](https://greenkeeper.io/)\n\nCreating new tradeshift npm libraries requires a lot of boilerplate configuration,\nand is prone to errors. Configurations will often diverge or never be updated.\n\n## This solution\n\nThis is a CLI that abstracts away all configuration for open source projects\nfor linting, testing, building, and more.\n\n## Table of Contents\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Inspiration](#inspiration)\n- [Other Solutions](#other-solutions)\n- [LICENSE](#license)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n## Installation\n\nThis module is distributed via [npm][npm] which is bundled with [node][node] and\nshould be installed as one of your project's `devDependencies`:\n\n```\nnpm install --save-dev tradeshift-scripts\n```\n\n\u003e Note: for now, you'll have to include an `.eslintignore` in your project until\n\u003e [this eslint issue is resolved](https://github.com/eslint/eslint/issues/9227).\n\n## Usage\n\nThis is a CLI and exposes a bin called `tradeshift-scripts`.\n\nThis project actually dogfoods itself. If you look in the `package.json`, you'll\nfind scripts with `node src {scriptName}`. This serves as an example of some\nof the things you can do with `tradeshift-scripts`.\n\nTo use the `after-success` hooks and automatic [semantic release][semantic-release],\nyou need to set up your build env with `GH_TOKEN` and `NPM_TOKEN`.\n\nIf you want to automatically publish coverage reports to [codecov][codecov], add\na `CODECOV_TOKEN`.\n\n\u003cdetails\u003e\n\u003csummary\u003eExample `package.json`\u003c/summary\u003e\n\n```json\n{\n\t\"name\": \"awesome-library\",\n\t\"version\": \"0.0.0-semantically-released\",\n\t\"main\": \"dist/index.js\",\n\t\"files\": [\"dist\"],\n\t\"scripts\": {\n\t\t\"test\": \"tradeshift-scripts test\",\n\t\t\"test:update\": \"tradeshift-scripts test --updateSnapshot\",\n\t\t\"build\": \"tradeshift-scripts build\",\n\t\t\"lint\": \"tradeshift-scripts lint\",\n\t\t\"format\": \"tradeshift-scripts format\",\n\t\t\"validate\": \"tradeshift-scripts validate\",\n\t\t\"precommit\": \"tradeshift-scripts precommit\",\n\t\t\"after-success\": \"tradeshift-scripts travis-after-success\"\n\t},\n\t\"devDependencies\": {\n\t\t\"tradeshift-scripts\": \"1.1.0\"\n\t}\n}\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eExample `.travis.yml`\u003c/summary\u003e\n\n```yaml\nsudo: false\nlanguage: node_js\ncache:\n  directories:\n    - node_modules\nnotifications:\n  email: false\nnode_js:\n  - '8'\nscript: npm run validate\nafter_success:\n  - npm run after-success\nbranches:\n  only:\n    - master\n```\n\n\u003c/details\u003e\n\n### Overriding Config\n\nUnlike `react-scripts`, `tradeshift-scripts` allows you to specify your own\nconfiguration for things and have that plug directly into the way things work\nwith `tradeshift-scripts`. There are various ways that it works, but basically if you\nwant to have your own config for something, just add the configuration and\n`tradeshift-scripts` will use that instead of it's own internal config. In addition,\n`tradeshift-scripts` exposes its configuration so you can use it and override only\nthe parts of the config you need to.\n\nThis can be a very helpful way to make _editor integration_ work for tools like\nESLint which require project-based ESLint configuration to be present to work.\n\nSo, if we were to do this for ESLint, you could create an `.eslintrc` with the\ncontents of:\n\n```\n{\"extends\": \"./node_modules/tradeshift-scripts/eslint.js\"}\n```\n\nOr, for `babel`, a `.babelrc` with:\n\n```\n{\"presets\": [\"tradeshift-scripts/babel\"]}\n```\n\nOr, for `jest`:\n\n```javascript\nconst { jest: jestConfig } = require('tradeshift-scripts/config');\nmodule.exports = Object.assign(jestConfig, {\n\t// your overrides here\n});\n```\n\n\u003e Note: `tradeshift-scripts` intentionally does not merge things for you when you start\n\u003e configuring things to make it less magical and more straightforward. Extending\n\u003e can take place on your terms. I think this is actually a great way to do this.\n\n## Inspiration\n\nThis is inspired by `react-scripts`.\n\n## Other Solutions\n\n`tradeshift-scripts` is a fork of [kcd-scripts][kcd], adapted to tradeshift.\n\n## LICENSE\n\nMIT\n\n[npm]: https://www.npmjs.com/\n[node]: https://nodejs.org\n[build-badge]: https://img.shields.io/travis/tradeshift/tradeshift-scripts.svg?style=flat-square\n[build]: https://travis-ci.org/tradeshift/tradeshift-scripts\n[coverage-badge]: https://img.shields.io/codecov/c/github/tradeshift/tradeshift-scripts.svg?style=flat-square\n[coverage]: https://codecov.io/github/tradeshift/tradeshift-scripts\n[version-badge]: https://img.shields.io/npm/v/tradeshift-scripts.svg?style=flat-square\n[package]: https://www.npmjs.com/package/tradeshift-scripts\n[downloads-badge]: https://img.shields.io/npm/dm/tradeshift-scripts.svg?style=flat-square\n[npmcharts]: http://npmcharts.com/compare/tradeshift-scripts\n[license-badge]: https://img.shields.io/npm/l/tradeshift-scripts.svg?style=flat-square\n[license]: https://github.com/tradeshift/tradeshift-scripts/blob/master/LICENSE\n[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square\n[prs]: http://makeapullrequest.com\n[donate-badge]: https://img.shields.io/badge/$-support-green.svg?style=flat-square\n[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square\n[coc]: https://github.com/tradeshift/tradeshift-scripts/blob/master/other/CODE_OF_CONDUCT.md\n[twitter]: https://twitter.com/intent/tweet?text=Check%20out%20tradeshift-scripts!%20https://github.com/tradeshift/tradeshift-scripts%20%F0%9F%91%8D\n[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/tradeshift/tradeshift-scripts.svg?style=social\n[kcd]: https://github.com/kentcdodds/kcd-scripts\n[semantic-release]: https://github.com/semantic-release/semantic-release\n[codecov]: https://codecov.io\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftradeshift%2Ftradeshift-scripts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftradeshift%2Ftradeshift-scripts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftradeshift%2Ftradeshift-scripts/lists"}