{"id":18469578,"url":"https://github.com/tricinel/frontwerk","last_synced_at":"2025-04-08T10:32:49.567Z","repository":{"id":27491107,"uuid":"114120216","full_name":"tricinel/frontwerk","owner":"tricinel","description":"CLI toolbox for common scripts for frontend projects","archived":false,"fork":false,"pushed_at":"2024-04-16T05:11:35.000Z","size":3148,"stargazers_count":10,"open_issues_count":92,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-23T11:33:07.489Z","etag":null,"topics":["babel","cli","eslint","frontend","jest","rollup","stylelint","webpack"],"latest_commit_sha":null,"homepage":null,"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/tricinel.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-12-13T12:50:18.000Z","updated_at":"2020-01-06T08:53:13.000Z","dependencies_parsed_at":"2023-10-15T16:21:49.117Z","dependency_job_id":"28c7f530-9abf-4afd-bada-d093696fdb4e","html_url":"https://github.com/tricinel/frontwerk","commit_stats":{"total_commits":89,"total_committers":5,"mean_commits":17.8,"dds":0.0674157303370787,"last_synced_commit":"d2c3b7dffb4ffeabb273bf37215a8d6394073939"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tricinel%2Ffrontwerk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tricinel%2Ffrontwerk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tricinel%2Ffrontwerk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tricinel%2Ffrontwerk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tricinel","download_url":"https://codeload.github.com/tricinel/frontwerk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247824277,"owners_count":21002242,"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":["babel","cli","eslint","frontend","jest","rollup","stylelint","webpack"],"created_at":"2024-11-06T10:10:57.216Z","updated_at":"2025-04-08T10:32:48.745Z","avatar_url":"https://github.com/tricinel.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Frontwerk\n\n![Frontwerk](https://i.imgur.com/oLbJD6J.jpg)\n\n![Build status][build-status-badge] ![Node Version][node-version-badge]\n![Npm version][npm-version-badge]\n[![Npm downloads][npm-downloads-badge]][frontwerk-npm] ![License][license-badge]\n[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors)\n\nCLI toolbox for common scripts for frontend projects that includes:\n\n* JS linting with [ESLint][eslint]\n* JS testing with [Jest][jest]\n* JS formatting with [Prettier][prettier]\n* CSS/SCSS linting with [Stylelint][stylelint]\n* Compile your JS with [Babel][babel]\n* Build your JS with [Rollup][rollup]\n* Build your app with [Webpack][webpack]\n\nComing soon:\n\n* Easily eject from using frontwerk (similar to [react-scripts][react-scripts]'s\n  eject)\n* [FlowJS][flow]\n\n\u003chr /\u003e\n\n## The problem\n\nWorking on multiple frontend projects where you need to set up the same tools\nand processes and then maintain them across all of them is a tideous job.\n\n## This solution\n\nFrontwerk is a CLI that abstracts away all those processes and configuration and\nexposes the same API that you can use across all your projects.\n\nYou can pick and choose which tools to use (i.e. if you don't want to format\nyour JS with prettier, you don't have to).\n\n## Inspiration\n\nThis is heavily inspired by [kcd-scripts][kcd-scripts] by the amazing Kent C.\nDodds (you should definitely follow him on [Twitter][twitter-kentcdodds] by the\nway) and [react-scripts][react-scripts].\n\nSo why not just use `kcd-scripts`? You absolutely should! We're not in a\nzero-sum game here. I basically wanted to learn how he created everything\nwithout even knowing I'd get this far!\n\n# Installation and usage\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```shell\nnpm install --save-dev frontwerk\n```\n\nor with [yarn][yarn]:\n\n```shell\nyarn add --dev frontwerk\n```\n\n## Usage\n\nThis is a CLI and exposes a bin called `frontwerk`. You can run\n\n```shell\nfrontwerk\n```\n\nwith no arguments to show a list of available commands. Or simply checkout the\n`src/scripts` directory for all the available scripts.\n\nThen simply ammend your `package.json` `scripts` property to include the scripts\nyou want to use:\n\n```json\n{\n  \"scripts\": {\n    \"lint:js\": \"frontwerk lint\",\n    \"lint:css\": \"frontwerk stylelint\",\n    \"test\": \"frontwerk test --no-watch\",\n    \"test:watch\": \"frontwerk test\",\n    \"build\": \"frontwerk build\",\n    \"format\": \"frontwerk format\"\n  }\n}\n```\n\n## Overriding the configuration\n\nAlthough it works out of the box, Frontwerk allows you to specify your own\nconfig for the various scripts, either by extending the config provided or just\nby using your own, depending on the script. Frontwerk respects the convention\nused by each of its underlying tools (eslint, stylelint, etc.). Basically, if\nit's possible with that tool, it's possible with frontwerk.\n\n**Example with ESLint**\n\n```json\n{\n  \"extends\": \"./node_modules/frontwerk/eslint.js\",\n  \"rules\": {}\n}\n```\n\nor, simply start with your own config to pass to ESLint:\n\n```json\n{\n  \"extends\": \"google\"\n}\n```\n\n\u003e Note that eslintignore is _coincidentally_ ignored, so until\n\u003e [this issue](https://github.com/eslint/eslint/issues/9227) is resolved, please\n\u003e pass the eslint ignore as allowed by\n\u003e [eslint's configuration](https://eslint.org/docs/user-guide/configuring).\n\n## Documentation\n\nYou can find more extensive documentation about each tool on the\n[website][frontwerkorg].\n\n## Contributors\n\nThanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore --\u003e\n| [\u003cimg src=\"https://avatars3.githubusercontent.com/u/216008?v=4\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eBogdan Lazar\u003c/b\u003e\u003c/sub\u003e](http://bogdanlazar.com)\u003cbr /\u003e[💻](https://github.com/tricinel/frontwerk/commits?author=tricinel \"Code\") [📖](https://github.com/tricinel/frontwerk/commits?author=tricinel \"Documentation\") [💡](#example-tricinel \"Examples\") [🤔](#ideas-tricinel \"Ideas, Planning, \u0026 Feedback\") [🔧](#tool-tricinel \"Tools\") | [\u003cimg src=\"https://avatars1.githubusercontent.com/u/835588?v=4\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eAlexander Plavinski\u003c/b\u003e\u003c/sub\u003e](http://cilice.me/)\u003cbr /\u003e[💻](https://github.com/tricinel/frontwerk/commits?author=cilice \"Code\") [📦](#platform-cilice \"Packaging/porting to new platform\") [🔧](#tool-cilice \"Tools\") | [\u003cimg src=\"https://avatars0.githubusercontent.com/u/32840183?v=4\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eYash Handa\u003c/b\u003e\u003c/sub\u003e](https://github.com/Yash-Handa)\u003cbr /\u003e[🔧](#tool-Yash-Handa \"Tools\") [📖](https://github.com/tricinel/frontwerk/commits?author=Yash-Handa \"Documentation\") | [\u003cimg src=\"https://avatars0.githubusercontent.com/u/7033136?v=4\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eSolomon Okwa\u003c/b\u003e\u003c/sub\u003e](http://about.me/Dikaeinstein)\u003cbr /\u003e[🔧](#tool-Dikaeinstein \"Tools\") [💻](https://github.com/tricinel/frontwerk/commits?author=Dikaeinstein \"Code\") |\n| :---: | :---: | :---: | :---: |\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!\n\n# LICENSE\n\nMIT\n\n[eslint]: https://eslint.org/\n[jest]: https://facebook.github.io/jest/\n[prettier]: https://prettier.io/\n[flow]: https://flow.org/\n[stylelint]: https://stylelint.io/\n[babel]: https://babeljs.io/\n[rollup]: https://rollupjs.org/\n[webpack]: https://webpack.js.org/\n[flow]: https://flow.org/\n[typescript]: http://www.typescriptlang.org/\n[npm]: https://www.npmjs.com/\n[yarn]: https://yarnpkg.com/\n[node]: https://nodejs.org\n[react-scripts]: https://www.npmjs.com/package/react-scripts\n[kcd-scripts]: https://github.com/kentcdodds/kcd-scripts/\n[twitter-kentcdodds]: https://twitter.com/kentcdodds\n[package]: https://www.npmjs.com/package/kcd-scripts\n[frontwerkorg]: https://frontwerk.org\n[license]: https://github.com/tricinel/frontwerk/blob/master/LICENSE\n[node-version-badge]: https://img.shields.io/node/v/frontwerk.svg?style=flat-square\n[license-badge]: https://img.shields.io/npm/l/frontwerk.svg?style=flat-square\n[npm-version-badge]: https://img.shields.io/npm/v/frontwerk.svg?style=flat-square\n[frontwerk-npm]: https://www.npmjs.com/package/frontwerk\n[npm-downloads-badge]: https://img.shields.io/npm/dt/frontwerk.svg?style=flat-square\n[build-status-badge]: https://img.shields.io/travis/tricinel/frontwerk.svg?style=flat-square\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftricinel%2Ffrontwerk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftricinel%2Ffrontwerk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftricinel%2Ffrontwerk/lists"}