This package has been deprecated

Author message:

Changed to use a GitHub template repository: https://github.com/xeroxinteractive/xerox-typescript-template

generator-xerox

Yeoman generator for Xerox open-source projects.

Usage

This is meant for internal Xerox use, but can be used externally to kickstart your project, but please note decissions made are primarily made for interal reasoning.

• Install the generator:

yarn global add generator-xerox
# or 
npm install generator-xerox --global

• Run the generator:

cd path/to/your-project
yo xerox

What you get

Structure

Once you have run the generator and answered the relevant questions, your project will have the following structure:

 .
├─ .editorconfig
├─ .gitignore
├─ LICENSE
├─ README.md
├─ package.json
├─ tsconfig.declarations.json
├─ tsconfig.json
├─ yarn.lock
├─ .circleci
│  └─ config.yml
├─ .vscode
│  ├─ extensions.json
│  └─ settings.json
├─ build
│  ├─ index.d.ts
│  └─ index.js
├─ source
│  └─ index.ts
└─ __tests__
      └─ index.test.ts

Commands

• yarn run build - Transpiles TypeScript from ./source/ into JavaScript + Deceleration files with Babel to ./build.
• yarn run test - Run all the **/__tests__/*.test.ts files with Jest.
• yarn run lint - Lint all the code with eslint showing warnings and errors.
• yarn run format - Fix all linting errors where possible.
• yarn rum circleci - Check the validity of the .circleci/config.yml file.

---

LICENSE | CHANGELOG | ISSUES