a-t-x-m / generator-package

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

@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

generator-package's Issues

TypeError: Cannot read property 'includes' of undefined

I am on macosx and I'm trying to generate an Atom package for typescript.

node v14.15.5

_-----_ | | ╭──────────────────────────╮ |--(o)--| │ Let's go & build a │---------´ │ package for Atom! │
( _´U_ ) ╰──────────────────────────╯ /___A___\ / | ~ | __'.___.'__ ´ |° ´ Y `

? Choose your preferred language TypeScript
? What do you want to name your package? another-pkg
? What is your package description? ts pkg
? What's your GitHub username? fithisux
? Is this a private package? No
? Choose a license MIT
? Package Features Keymaps
? Add activation command? No
? Add activation hooks? Loaded Shell Environment
? Add workspace openers? No
? Depend on other Atom packages? No
? Specify additional dependencies Developer Console
? Linter Hook pre-commit
? Add CI configuration GitHub Actions
? ESLint Configuration ESLint
TypeError: Cannot read property 'includes' of undefined
at Object.when (/usr/local/lib/node_modules/@atxm/generator-package/generators/app/index.js:462:41)
at /usr/local/lib/node_modules/yo/node_modules/run-async/index.js:49:25
at new Promise ()
at /usr/local/lib/node_modules/yo/node_modules/run-async/index.js:26:19
at /usr/local/lib/node_modules/yo/node_modules/yeoman-environment/node_modules/inquirer/lib/ui/prompt.js:135:32
at Observable._subscribe (/usr/local/lib/node_modules/yo/node_modules/rxjs/internal/observable/defer.js:10:21)
at Observable._trySubscribe (/usr/local/lib/node_modules/yo/node_modules/rxjs/internal/Observable.js:44:25)
at Observable.subscribe (/usr/local/lib/node_modules/yo/node_modules/rxjs/internal/Observable.js:30:22)
at Object.innerSubscribe (/usr/local/lib/node_modules/yo/node_modules/rxjs/internal/innerSubscribe.js:102:23)
at MergeMapSubscriber._innerSub (/usr/local/lib/node_modules/yo/node_modules/rxjs/internal/operators/mergeMap.js:80:50)
TypeError: Cannot read property 'includes' of undefined
at Object.when (/usr/local/lib/node_modules/@atxm/generator-package/generators/app/index.js:462:41)
at /usr/local/lib/node_modules/yo/node_modules/run-async/index.js:49:25
at new Promise ()
at /usr/local/lib/node_modules/yo/node_modules/run-async/index.js:26:19
at /usr/local/lib/node_modules/yo/node_modules/yeoman-environment/node_modules/inquirer/lib/ui/prompt.js:135:32
at Observable._subscribe (/usr/local/lib/node_modules/yo/node_modules/rxjs/internal/observable/defer.js:10:21)
at Observable._trySubscribe (/usr/local/lib/node_modules/yo/node_modules/rxjs/internal/Observable.js:44:25)
at Observable.subscribe (/usr/local/lib/node_modules/yo/node_modules/rxjs/internal/Observable.js:30:22)
at Object.innerSubscribe (/usr/local/lib/node_modules/yo/node_modules/rxjs/internal/innerSubscribe.js:102:23)
at MergeMapSubscriber._innerSub (/usr/local/lib/node_modules/yo/node_modules/rxjs/internal/operators/mergeMap.js:80:50)
➜ another-pkg
➜ another-pkg
`

BTW thank you! We need this kind of help to keep Atom alive.

Cannot install

I get

verbose stack Error: @atxm/[email protected] postinstall: husky install``

I'm on MacOSX Darwin Kernel Version 20.6.0 x64

npm: 6.14.15
node: v14.17.6