{"id":19658118,"url":"https://github.com/cdaringe/shizam","last_synced_at":"2025-11-07T15:05:53.582Z","repository":{"id":57146196,"uuid":"59235111","full_name":"cdaringe/shizam","owner":"cdaringe","description":"tiny opinionated helper to help scaffold your npm/node project with some practical hooks/scripts ⚡️","archived":false,"fork":false,"pushed_at":"2023-12-15T05:52:04.000Z","size":586,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-18T06:08:49.517Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cdaringe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-05-19T19:19:00.000Z","updated_at":"2020-07-30T12:34:56.000Z","dependencies_parsed_at":"2022-09-06T05:51:02.767Z","dependency_job_id":null,"html_url":"https://github.com/cdaringe/shizam","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdaringe%2Fshizam","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdaringe%2Fshizam/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdaringe%2Fshizam/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdaringe%2Fshizam/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cdaringe","download_url":"https://codeload.github.com/cdaringe/shizam/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240965801,"owners_count":19885967,"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":[],"created_at":"2024-11-11T15:36:09.898Z","updated_at":"2025-11-07T15:05:53.533Z","avatar_url":"https://github.com/cdaringe.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# shizam 🔮⚡️\n\n![](https://img.shields.io/badge/standardjs-%E2%9C%93-brightgreen.svg)\n\nopinionated project scaffolding for **libraries**.  one `yarn add --dev shizam` install automatically wires:\n\n- `lint` scripts, via `standard`\n- `lint` \u0026 `test` task runs on git precommit, using `husky`\n- automatic `jsdoc` publishing, post-package publish\n\n## why\n\nwriting boilerplate code over and over stinks.  many of us start new projects _all the time_ and want to easily distribute the structure and methodologies used in all of our projects.  this tiny package simply helps scaffold a common project structure and best of best-known-methods via npm scripts.\n\n\"ugh, what's the problem with just doing these things on my own?\"\n\nnothing!  i, however, found that [xkcd justified the effort](http://imgs.xkcd.com/comics/is_it_worth_the_time.png). it's great to start a project, install _just one package_ (this one), and automatically have a basic set of scripts and tooling ready-to-roll. #not-a-framework.\n\n## how\n\nspecifically, this package does the following to your project:\n  - install common npm scripts (e.g. `\"test\"`, `\"prepublish\"`, etc)\n  - installs common pre-commit hooks (e.g. lint, test)\n  - installs packages that are required for the above tasks to be successful\n\nthis package lets you modify the default scripts to your own requirements post-install. on re-install or update, it will NOT squash your modified scripts.  it will, however, continue to install dev dependencies that it thinks are mandatory on subsequent installs.\n\n## what opinions are assumed?\n\nthis module scaffolds the following topics using the following packages:\n\n- git precommit hooks (`test` \u0026 `lint`). bring your own `test: ...` script.\n- linting (`standard`)\n- docs\n  - doc generation (`jsdoc`)\n  - doc publishing to github.io (`gh-pages`, publishes on `npm postpublish`)\n\nrequired devDependencies are installed whenever `shizam` is installed/updated/etc _iff_ they are missing.\n\n## usage\n\n`yarn add --dev shizam`\n\neverything else happens automatically!  and that's the point :)\n\n## contributing\n\ngo for it.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcdaringe%2Fshizam","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcdaringe%2Fshizam","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcdaringe%2Fshizam/lists"}