Pyre

A CLI helper for common Sunbird development tasks

Description
Install
Usage Examples
Shell Completion Files

Description

Pyre is a CLI used to simplify some of the Sunbird development teams common tasks.

In these early stages, it is currently capable of automating the boilerplate file creation necessary for implimenting new features in the different Sunbird Angular projects.

The intention is that as more pain points are indentified Pyre can be expanded to help alleviate those tasks as well.

Installation

Via Prebuilt Binaries

Prebuilt binaries are available for a variety of operating systems and architectures. Visit the latest release page, and scroll down to the Assets section.

Download the archive for the desired edition, operating system, and architecture
Extract the archive
Move the executable to the desired directory
Add this directory to the PATH environment variable
Verify that you have execute permission on the file

Please consult your operating system documentation if you need help setting file permissions or modifying your PATH environment variable.

Via `go install`

go install github.com/wolves/pyre@latest

This installs a go binary that will automatically bind to your $GOPATH

Usage

`feature create`

This command will generate the necessary Angular feature boilerplate files including specs and state management architecture. The component naming will be camel cased within the generated files (eg. YourFeatureName) but should be provided as kebab-case like in the example.

The --path/-p flag is required in order to determine the location that the feature directory should be created.

--no-tests/-x can be provided as a flag if you wish to generate the feature files but exclude the test specs

Example:

pyre feature create your-feature-name -p ~/code/project-name/features-folder

Results in:

~/code/project-name/features-folder/your-feature-name
├── src
│  ├── +state
│  │  ├── state.ts
│  │  ├── your-feature-name-state.module.ts
│  │  ├── your-feature-name.actions.spec.ts
│  │  ├── your-feature-name.actions.ts
│  │  ├── your-feature-name.effects.spec.ts
│  │  ├── your-feature-name.effects.ts
│  │  ├── your-feature-name.facade.spec.ts
│  │  ├── your-feature-name.facade.ts
│  │  ├── your-feature-name.reducer.spec.ts
│  │  ├── your-feature-name.reducer.ts
│  │  └── your-feature-name.selector.ts
│  ├── assets
│  │  └── translations
│  │     ├── de
│  │     │  ├── index.ts
│  │     │  └── your-feature-name.i18n.ts
│  │     ├── en
│  │     │  ├── index.ts
│  │     │  └── your-feature-name.i18n.ts
│  │     ├── fr
│  │     │  ├── index.ts
│  │     │  └── your-feature-name.i18n.ts
│  │     ├── ja
│  │     │  ├── index.ts
│  │     │  └── your-feature-name.i18n.ts
│  │     ├── ru
│  │     │  ├── index.ts
│  │     │  └── your-feature-name.i18n.ts
│  │     ├── tr
│  │     │  ├── index.ts
│  │     │  └── your-feature-name.i18n.ts
│  │     ├── zh
│  │     │  ├── index.ts
│  │     │  └── your-feature-name.i18n.ts
│  │     └── translations.ts
│  ├── models
│  │  ├── your-feature-name-response.model.ts
│  │  └── your-feature-name.model.ts
│  ├── services
│  │  ├── your-feature-name.adapter.ts
│  │  ├── your-feature-name.service.spec.ts
│  │  └── your-feature-name.service.ts
│  ├── your-feature-name-routing.module.ts
│  ├── your-feature-name.component.html
│  ├── your-feature-name.component.scss
│  ├── your-feature-name.component.spec.ts
│  ├── your-feature-name.component.ts
│  └── your-feature-name.module.ts
├── index.ts
├── ng-package.json
└── public-api.json

Shell Completion Files

Shell auto-completion files for Bash, Zsh, and Fish can be found in the completions/ directory that is provided within any of the Archives on the releases page. Once downloaded and extracted you can copy/move the completions file for your shell to the necessary location.

wolves/pyre