generator-esmodules-generator

Welcome to generator-esmodules-generator 👋

Yeoman generator to create yeoman generators based in ES Modules.

What's changed? See generator-esmodules-generator releases

🏠 Homepage

The generator-esmodules-generator provides a structure to create a yeoman generator using ES Modules.

The structure created by this generator includes:

• Jest
• Babel with @babel/cli, @babel/core, @babel/plugin-transform-runtime, @babel/preset-env, @babel/runtime-corejs3 and core-js
• Eslint with eslint-config-prettier, eslint-config-standard, eslint-plugin-jest, eslint-plugin-jsdoc, etc.
• Prettier with prettier-plugin-jsdoc
• Lint-staged
• Faker
• Commitlint
• Readme-md-generator
• Husky
• Others

Example of a generator created by generator-esmodules-generator:

Index

• Installation
• Prerequisites
• Arguments and options
• Generators included
• The configuration files
• The question: Do you want to automatically run the scripts that configure the package, then installing the dependencies?
• The scripts in package.json
• Getting To Know Yeoman
• Author
• Contributing
• Show your support
• License

Installation

First, install Yeoman and generator-esmodules-generator using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-esmodules-generator

Then generate your new project:

yo esmodules-generator generator_name

Prerequisites

First, you must create a folder, then you enter it using the terminal. Finally you runs.

yo esmodules-generator generator_test

Example:

PS C:\Users\...\generator_es6> yo esmodules-generator generator_test

Arguments and options

The generator-esmodules-generator include only an argument called generatorName and it is required:

For example: If you want to create a new generator called generator_test (generatorName = generator_test), you should use:

yo esmodules-generator generator_test

The generator-esmodules-generator include various options, these are:

option	value	default	description	example
onlyTerminal	Boolean	false	If this option is used, the yeoman prompts will not be used when there are missing options.	yo esmodules-generator generator_name --onlyTerminal
generatorDescription	String	''	Description used into package.json	yo esmodules-generator generator_name --generatorDescription=description
generatorKeywords	String	''	Generator keywords (comman to split)	yo esmodules-generator generator_name --generatorKeywords=keyword1,keyword2,keyword3
license	String	NO_LICENSE	Any lincese accepted by generator-license, for example: Apache-2.0, MIT, MPL-2.0 BSD-2-Clause-FreeBSD, BSD-3-Clause, ISC, etc	yo esmodules-generator generator_name --license=MIT
authorName	String	''	Author's name	yo esmodules-generator generator_name --authorName=author
authorEmail	String	''	Author's email	yo esmodules-generator generator_name --authorEmail=[e-mail]
authorHomepage	String	''	Author's homepage	yo esmodules-generator generator_name --authorHomepage=www.authorhomepage.com
urlRepository	String	''	Github repository url	yo esmodules-generator generator_name --urlRepository=urlrepository
generatorHomePageUrl	String	''	Project homepage url	yo esmodules-generator generator_name --generatorHomePageUrl=www.generatorHomePage.com
runGitInit	Boolean	false	Run git init automatically, then installing the dependencies	yo esmodules-generator generator_name --runGitInit
runPackageScripts	Boolean	false	Run the scripts that configure the package, then installing the dependencies	yo esmodules-generator generator_name --runPackageScripts

Generators included

The generators included are:

esmodules-generator:app used by yo esmodules-generator: It is the generator used by default.

esmodules-generator:subgenerator: It is used to create and exports subgenerators into the generator created by yo esmodules-generator.

When to enter in the folder where you creates your generator using yo esmodules-generator, you can use the following commands:

• yo esmodules-generator:subgenerator subGeneratorName --create: Creates a subgenerator with name subGeneratorName.

• yo esmodules-generator:subgenerator subGeneratorName --exports: Exports subGeneratoName. It adds to exports field (package.json) the properties types (exports the declaration files) and import (exports the subgenerator as ES Modules).

  Example:

  In default package.json created by esmodules-generator

  "exports": {
    ".": {
      "types": "./dist/types/generators/app/index.d.ts",
      "import": "./dist/generators/app/index.js"
    },
    "./app": {
      "types": "./dist/types/generators/app/index.d.ts",
      "import": "./dist/generators/app/index.js"
    }
  }

  The --create and --exports options can be combined.

  PS C:\Users\...\generator_es6> yo esmodules-generator:subgenerator subapp --create --exports

  package.json

  "exports": {
    ".": {
      "types": "./dist/types/generators/app/index.d.ts",
      "import": "./dist/generators/app/index.js"
    },
    "./app": {
      "types": "./dist/types/generators/app/index.d.ts",
      "import": "./dist/generators/app/index.js"
    },
    "./subapp": {
      "types": "./dist/types/generators/subapp/index.d.ts",
      "import": "./dist/generators/subapp/index.js"
    }
  },

The configuration files

The configuration files included are:

• Eslint: .eslintignore (the files and directories ignored by eslint) and .eslintrc.json (configuration used by eslint).

• Git: .gitignore (the files and directories ignored by git).

• Lint-staged: .lintstagedrc.json (configuration used by lint-staged).

• Prettier: .prettierignore (the files and directories ignored by prettier) and .prettierrc.json (configuration used by prettier).

• Babel: babel.config.json (configuration used by babel):

  • The env.buildESmodules contains the configuration used to transpile the source code to es6.

• Commitlint: commitlint.config.js (configuration used by commitlint).

• Jest: jest.config.js (configuration used by jest).

• TypeScript: tsconfig.json (configuration used by TypeScript compiler).

The question: Do you want to automatically run the scripts that configure the package, then installing the dependencies?

When you selects the true value, the following scripts ubicated in the package.json are executed:

• init
• documentation:create
• format:fix
• test
• build

If you selects the false value, you must run npm run init obligatory.

The scripts in package.json

The more important scripts added into the package.json created by this generator are:

• "init": Runs the commands necessary to initialize the package, for example init:husky.
• "documentation:create": Creates documentation using readme-md-generator.
• "format": Checks the format using prettier.
• "format:fix": Fixes the format using prettier.
• "format:build-stage" and "format:build-stage:fix": similar to "format" and "format:fix". They used when the npm run build is called.
• "lint": static code analysis using eslint.
• "lint:fix": Fixes the code using eslint.
• "lint:build-stage" and "lint:build-stage:fix": similar to "lint" and "lint:fix". They are used when the npm run build is called.
• "build:tsc": Generates .d.ts files using the TypeScript compilator. It is used when the npm run build is called.
• "build:es6": Transpiles the source code to es6 using babel.
• "build": Generates the dist folder that contains the generators folder (it contains the source code transpiled to es6) and types folder (it contains the declaration files). If you want to manually test your generator you should use npm link and npm run build. See yeoman Running the generator
• "prepublishOnly": Used before publishing your package using npm publish. Runs npm run build.
• "test": Runs the tests using jest.
• "commitlint": Runs commitlint. It is used into .husky/commit-msg file. It is called by the commit-msg hook. See git hook.
• "lint-staged": Runs lint-staged. It is used into .husky/pre-commit file. It is called by the pre-commit hook. See git hook.
• "quality-check": Runs npm run format && npm run lint && npm run test. It is used into .husky/pre-push file. It is called by the pre-push hook See git hook.

Getting To Know Yeoman

• Yeoman has a heart of gold.
• Yeoman is a person with feelings and opinions, but is very easy to work with.
• Yeoman can be too opinionated at times but is easily convinced not to be.
• Feel free to learn more about Yeoman.

Author

👤 Cristopher Jiménez

• Github: @cristopher1

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2023 Cristopher Jiménez.
This project is MIT licensed.

---

This README was generated with ❤️ by readme-md-generator