@atxm/generator-package

@atxm/generator-package

Description

A Yeoman generator for Atom packages written in JavaScript, TypeScript or CoffeeScript.

Features

• scaffolds Atom packages written in JavaScript, TypeScript or CoffeeScript 2.x
• bundles package with Rollup or Webpack
• adds linter configurations
  • CoffeeLint
  • ESLint
  • stylelint
• adds CI configurations
  • CircleCI
  • GitHub Actions
  • Travis CI
  • Bitbucket Pipelines (limited to private packages)
• adds Atom package dependencies
• adds SPDX license
• adds activationHooks / activationCommands
• supports loaders for CSS/SCSS
• supports Babel presets
• adds development scripts
• links development packages

Prerequisites

You need Node.js installed and available in your PATH environment variable. Use your preferred Node package manager to install the Yeoman CLI tool.

npm install -g yo

Installation

Use your preferred Node package manager to install the CLI tool

npm i @atxm/generator-package -g

Usage

Create a new directory for your package and change into it:

cd ~/.atom/packages
mkdir my-package
cd my-package

Next, run the generator and follow its instructions. Use --helpto list available flags.

yo @atxm/package

ℹ️ If you prefer graphical user interfaces, atom-yeoman lets you use this generator within Atom!

License

This work is dual-licensed under The MIT License and the GNU General Public License, version 2.0