This repository is a robust template for JavaScript development using npm. It comes equipped with tools for formatting, spell-checking, a ready-to-use devcontainer, custom VS Code settings, essential repo files, automated checks, integrated VS Code extensions, semantic releases, and extensive in-repo guides for project management and customization.
- Devcontainer & VS Code: Ubuntu‑based Docker container with Node.js 20 and Python (for pre‑commit). Includes recommended VS Code extensions, workspace settings, and a seamless Codespaces experience.
- Dependency Management: npm for declarative
package.jsonconfiguration andpackage-lock.jsonlocking. - Formatting: Prettier for JavaScript, JSON, Markdown, and YAML; enforced via pre-commit hooks and editor integrations.
- Pre-commit Hooks: Runs Prettier, yamllint, markdownlint, markdown-link-check, and other checks before commit.
- Release Automation: semantic-release on pushes to
mainto analyze commits, bump versions, generate changelogs, and publish GitHub releases automatically. - In-Repo Guides:
CONTRIBUTING.md,STYLEGUIDE.md,SECURITY.mdto enforce best practices and streamline onboarding.
Designed for GitHub Codespaces—running locally is untested and may require extra configuration.
Most manual quality checks and workflows are exposed via package.json scripts. These commands mirror the editor
integrations, pre-commit hooks, and CI pipelines.
npm run format # check formatting
npm run format-fix # apply formatting fixes
npm run spell # run cspellContributions are welcome! Please read the Contributing Guidelines and check the Issues page.
This project is licensed under the MIT License.
For questions, reach out via evgenii.shiliaev@jekwwer.com or open an issue.
This document is based on a template by Evgenii Shiliaev, licensed under CC BY 4.0. All additional content is licensed under LICENSE.
