Skip to content

Latest commit

 

History

History
199 lines (147 loc) · 11.7 KB

README.md

File metadata and controls

199 lines (147 loc) · 11.7 KB
Raw

boundation

Status of the GitHub Workflow: bevry NPM version NPM downloads
GitHub Sponsors donate button ThanksDev donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button
Discord server badge Twitch community badge

Automatic scaffolding and upgrading of your JavaScript ecosystem projects using Bevry's best practices

Usage

Install the package globally on Node.js v12 or higher using npm install --global boundation then run boundation on your project or in an empty directory.

It will ask you several questions about your project, then initialise or upgrade the project with the latest Bevry best-practices.

Features

  • Supports JavaScript, TypeScript, CoffeeScript, and Website projects
  • Automatic Editions setup and upgrades for automatic selection of the best edition for the environment, allowing you to develop for the latest environment with the latest technology, then automatically test on and support older environments
    • Automated edition generation so the one package can be used between Node.js, Web Browsers, and Deno where applicable
    • Automated ES6 Import and CJS Require compatibility generation
    • Automated compatible editions generated for Web Browsers, Node.js, Deno
    • Each generated edition is targeted specifically for each version of each target that you intend to support, with each edition compatibility tested by Testen and trimmed if redundant overlaps are present
  • Uses Projectz to automatically generate and maintain your readme, license, badges, and the contributing file
  • Automatically configures sensible defaults based on the features that your project is using, while maintaining support for your extensions and customisations, supports
    • TSConfig for JavaScript and TypeScript projects
    • ESLint for JavaScript and TypeScript projects
    • Flow for JavaScript projects
    • CoffeeLint for CoffeeSCript projects
    • Zeit's Now and Next.js
    • DocPad Plugins
  • Automatically gives you documentation generation and publishing for the following:
    • TypeDoc for TypeScript projects
    • JSDoc for JavaScript projects
    • YUIDoc for new CoffeeScript projects, and Biscotto for older projects
  • Automated GitHub Actions setup and configuration for a variety of projects
  • Automated package dependency upgrades and migrations to compatible versions
  • Powerful NPM Scripts
    • npm run our:setup for setting up the project for development
      • automatic addition of your my:setup:* scripts
    • npm run our:compile for compiling the project
      • automatic addition of your my:compile:* scripts
    • npm run our:deploy for linting
      • automatic addition of your my:deploy:* scripts
    • npm run our:meta for compiling the meta files
      • automatic addition of your my:meta:* scripts
    • npm run our:verify for linting and tests
      • automatic addition of your my:verify:* scripts
    • npm run our:release for for releasing your project
      • on code projects, it will run verify, check for uncommitted changes, a changelog entry, performing the git tag automatically, and the git push
      • on website projects, it will run verify and git push
      • automatic addition of your my:release:* scripts

Install

npm

Install Globally

  • Install: npm install --global boundation
  • Executable: boundation

Install Locally

  • Install: npm install --save boundation
  • Executable: npx boundation
  • Import: import pkg from ('boundation')
  • Require: const pkg = require('boundation').default

Editions

This package is published with the following editions:

  • boundation aliases boundation/source/index.js
  • boundation/source/index.js is ESNext source code for Node.js 18 || 20 || 21 with Import for modules

History

Discover the release history by heading on over to the HISTORY.md file.

Backers

Code

Discover how to contribute via the CONTRIBUTING.md file.

Authors

Maintainers

Contributors

Finances

GitHub Sponsors donate button ThanksDev donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button

Sponsors

  • Andrew Nesbitt — Software engineer and researcher
  • Balsa — We're Balsa, and we're building tools for builders.
  • Codecov — Empower developers with tools to improve code quality and testing.
  • Frontend Masters — The training platform for web app engineering skills – from front-end to full-stack! 🚀
  • Mr. Henry
  • Poonacha Medappa
  • Rob Morris
  • Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
  • Syntax — Syntax Podcast

Donors

License

Unless stated otherwise all works are:

and licensed under: