[{"_1":2,"_161":-5,"_162":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_140":141},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_129":-5,"_130":11,"_131":21,"_132":11,"_133":-5,"_134":11,"_135":-5,"_136":137,"_138":91,"_139":-7},"canonicalUrl","https://hub.docker.com/r/fgribreau/check-build/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","fgribreau","reponame","check-build","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":21,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2015-04-01T14:41:30.706877Z","description","","is_private","last_updated","2020-07-09T10:33:37.442226Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",1089,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","[![Deps](https://img.shields.io/david/FGRibreau/check-build.svg)](https://david-dm.org/FGRibreau/check-build) [![Version](https://img.shields.io/npm/v/check-build.svg)](http://badge.fury.io/js/check-build) [![Downloads](http://img.shields.io/npm/dm/check-build.svg)](https://www.npmjs.com/package/check-build) [![](https://images.microbadger.com/badges/image/fgribreau/check-build.svg)](https://microbadger.com/images/fgribreau/check-build)\n\n[![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/francois-guillaume-ribreau?utm_source=github&utm_medium=button&utm_term=francois-guillaume-ribreau&utm_campaign=github) [![available-for-advisory](https://img.shields.io/badge/available%20for%20consulting%20advisory-yes-ff69b4.svg?)](http://bit.ly/2c7uFJq) ![extra](https://img.shields.io/badge/actively%20maintained-yes-ff69b4.svg) [![Twitter Follow](https://img.shields.io/twitter/follow/fgribreau.svg?style=flat)](https://twitter.com/FGRibreau) [![Slack](https://img.shields.io/badge/Slack-Join%20our%20tech%20community-17202A?logo=slack)](https://join.slack.com/t/fgribreau/shared_invite/zt-edpjwt2t-Zh39mDUMNQ0QOr9qOj~jrg)\n\n![NPM](https://nodei.co/npm/check-build.png?downloadRank=true) ![NPM](https://nodei.co/npm-dl/check-build.png?months=3&height=2)\n\n**Check-build** - Verify that your NodeJS project follow team conventions, is well written, up to date and *secure*.\n\n\n> “Each time I start a new project/mvp/poc/module I don't want to create/edit a new grunt/gulp file or whatever hype dev use these days.\n> I want an already packed CLI with good defaults (mine) that I can drop into my continuous build/integration process.\n> Let's build that once and for all.”\n>\n> – 10/19/2014\n\n

\n\n

\n\n# Usage\n\n```shell\nnpm install check-build -g\ncd /path/to/your/project\ncheck-build\n# [...] (sub-module output)\necho $?\n# 0 if everything went right, 1 otherwise.\n```\n\n# What's inside\n\n### Code error and potential problem detection\n\n- [JSHint](https://github.com/jshint/jshint) Static analysis tool for JavaScript (using [JSHint stylish](https://github.com/sindresorhus/jshint-stylish)). If `.jshintrc` is not present in project root, check-build will use this [.jshintrc](./defaults/.jshintrc).\n- [ESLint](http://eslint.org/) The pluggable linting utility for JavaScript and JSX, check-build will use a [.eslintrc](./defaults/.eslintrc) file for ESLint configuration.\n- [JSXHint](https://github.com/STRML/JSXHint) **JSXHint is DEPRECATED in favor of ESLint** Static analysis tool for JavaScript and JSX. If `.jshintrc` is not present in project root, check-build will use this [.jshintrc](./defaults/.jshintrc).\n\n### Code style checking\n\n- [JSCS](https://github.com/jscs-dev/node-jscs) Check the code style of your code. If `.jscsrc` is not present in project root, check-build will use this [.jscsrc](./defaults/.jscsrc).\n\n### Code quality\n- [Plato](https://github.com/es-analysis/plato) Detect structural complexity in your code, per files.\n\n### D.R.Y\n\n- [JSInspect](https://www.npmjs.org/package/jsinspect) Detect structural similarities in your code.\n- [buddy.js](https://github.com/danielstjules/buddy.js) Detect magic number in your code.\n\n### Freshness\n\n- [David](https://github.com/alanshaw/david) Check that your project dependencies are up to date.\n\n### Security\n\n- [Nsp](https://github.com/nodesecurity/nsp) Check your project dependencies for security issues.\n\n*Note: check-build uses a temporary fork of nsp adding a `--subdeb-warn-only` argument, [see why here](https://github.com/nodesecurity/nsp/pull/58)*\n\n

\n\n

\n\n# Philosophy\n\n- Leverage simplicity over performance. `check-build` will be run automatically by a build bot. I #%£€)° don't care about performance, I want code quality and ease of use.\n- Don't reinvent the wheel, leverage each module own configuration file. E.g. `.jshintrc`.\n- Even if the underneath module is not capable of handling multiple files, abstract it.\n- Use `multimatch` everywhere.\n- `.checkbuild` is there to configure each module (in case they don't use dot files for configuration), checkbuild will forward these parameters to each module implementation.\n\n# Checkbuild configuration\n\nPut a `.checkbuild` file ([example](./defaults/.checkbuild)) in your project root directory.\n\n```javascript\n{\n // Extends the current checkbuild file with others (optionnal)\n \"extends\": [\"./.checkbuildrc_base\"],\n // Download some distant files and save them into check-build command current directory\n // Usefull when used with extends (optionnal)\n \"urls\": [\"https://raw.githubusercontent.com/FGRibreau/javascript/master/.checkbuildrc_base\"],\n \"checkbuild\": {\n \"enable\": [\"jshint\", \"eslint\", \"jscs\", \"jsinspect\", \"plato\", \"nsp\", \"david\"],\n // don't exit immediately if one of the tools reports an error (default true)\n \"continueOnError\": true,\n // don't exit(1) even if we had some failures (default false)\n \"allowFailures\": false\n },\n\n \"david\": {\n \"warn\": {\n \"E404\": true\n },\n \"ignore\": [\"socket.io\"] // don't check socket.io package with david\n // ... and so on.\n },\n\n \"jshint\": {\n \"args\": [\"src/**/*.js\"]\n // instead of putting a .jshintrc inside each of your project with check-build\n // you can specify an URL.\n // That URL will be downloaded each time check-build is run\n // and its content will be saved inside check-build command current directory.\n // for instance the above .checkbuild jshint configuration:\n // \"url\":\"https://raw.githubusercontent.com/FGRibreau/javascript/master/.jshintrc_base\"\n // will download the jshintrc_base (the common jshint convention for your organization) inside your project.\n // This .jshintrc_base should be ignored from git and NOT commited.\n // Then, create and commit a .jshintrc that contains at least:\n // {\n // \"extends\": \"./.jshintrc_base\",\n // ...\n // }\n // inside this .jshintrc file you will be able to put project-specific jshint configuration.\n },\n\n \"eslint\": {\n \"args\": [\"src/**/*.js\", \"src/**/*.jsx\"],\n // instead of putting a .eslintrc inside each of your project with check-build\n // you can specify an URL.\n // That URL will be downloaded each time check-build is run\n // and its content will be saved inside check-build command current directory.\n // for instance the above .checkbuild jshint configuration:\n // \"url\":\"https://raw.githubusercontent.com/FGRibreau/javascript/master/.eslintrc_base\"\n // will download the eslintrc_base (the common eslint convention for your organization) inside your project.\n // This .eslintrc_base should be ignored from git and NOT commited.\n // Then, create and commit a .eslintrc that contains at least:\n // {\n // \"extends\": [\"./.eslintrc_base\"],\n // ...\n // }\n // inside this .eslintrc file you will be able to put project-specific ESLint configuration.\n // ... and so on.\n },\n\n \"jscs\": {\n \"args\": [\"lib/**.js\"]\n // ... and so on.\n // instead of putting a .jscrc inside each of your project with check-build\n // you can specify an URL.\n // That URL will be downloaded each time check-build is run\n // and its content will be saved inside check-build command current directory\n // \"url\":\"https://raw.githubusercontent.com/FGRibreau/javascript/master/.jscsrc\"\n },\n\n \"jsinspect\": {\n \"args\": [\"*.js\"],\n \"diff\": true\n // ... and so on.\n },\n\n \"buddyjs\": {\n \"args\": [\"*.js\"],\n \"ignore\": [0, 1, 200]\n // ... and so on.\n },\n\n \"plato\": {\n \"args\": [\"*.js\"],\n // define your project minimum average maintainability level\n \"maintainability\": 75.00\n },\n\n \"nsp\": {\n \"args\": []\n },\n\n \"david\": {\n \"dev\": false,\n // whether to check devDependencies or not (default false)\n \"stable\": true,\n // whether to check dependencies or not (default true)\n \"ignore\": []\n // put ignored dependencies here (both devDependencies and dependencies)\n }\n}\n\n```\n*Note: the `url` attribute presented for eslint is available for each extension*\n\n

\n\n

\n\n# Final goal\n\nA (NodeJS) project can be automatically analyzed in many dimension like code-consistency, d-r-y-ness and security. Check-build's final goal is to take the human out of the loop.\n\n## Donate\n\nI maintain this project in my free time, if it helped you please support my work [via paypal](https://paypal.me/fgribreau) or [Bitcoins](https://www.coinbase.com/fgribreau), thanks a lot!\n\n\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",3106281327,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_101":102,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":108,"_126":118,"_127":66,"_128":21},"content_type","creator",245288,"digest","sha256:df1d2875dac1ff78765a0911323674dde6125e5f4a74a5b024a9841b97c7b908","full_size",363052950,"id",158434,"images",[103],{"_104":105,"_95":96,"_106":48,"_107":108,"_109":110,"_111":112,"_113":48,"_114":-5,"_115":116,"_63":66,"_117":-5},"architecture","amd64","features","last_pulled","2026-10-06T10:15:02.412015015Z","last_pushed","2020-07-09T10:33:38Z","os","linux","os_features","os_version","size",363052790,"variant","2020-07-09T10:33:37.113994Z","last_updater","last_updater_username","media_type","latest","repository",170479,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":142,"_149":150,"_136":159,"_160":11},{"_40":143,"_42":144,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":145,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":146,"_79":21,"_80":148,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":147},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_151":64,"_152":-5,"_153":-5,"_154":155},"count","next","previous","results",[156],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_101":157,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":108,"_126":118,"_127":66,"_128":21},[158],{"_104":105,"_95":96,"_106":48,"_107":108,"_109":110,"_111":112,"_113":48,"_114":-5,"_115":116,"_63":66,"_117":-5},[],"canDeleteTags","actionData","errors"]

fgribreau/check-build

Tags for fgribreau/check-build