Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ArchitectNow/cli
ArchitectNow CLI
https://github.com/ArchitectNow/cli
architectnow cli inquirer typescript
Last synced: 26 days ago
JSON representation
ArchitectNow CLI
- Host: GitHub
- URL: https://github.com/ArchitectNow/cli
- Owner: ArchitectNow
- License: mit
- Created: 2020-04-26T13:25:17.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-23T23:05:35.000Z (30 days ago)
- Last Synced: 2024-08-24T00:23:04.388Z (30 days ago)
- Topics: architectnow, cli, inquirer, typescript
- Language: TypeScript
- Size: 355 KB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @architectnow/cli
This is a generic CLI to be used for multiple projects at **ArchitectNow**
## Installations
```
npm i -g @architectnow/cli
yarn add global @architectnow/cli
```
or use `npx`
```
npx @architectnow/cli
```
## Usage
Once installed, `architectnow` command will be available. Current available sub-commands are:
- `permissions`
- `lokalise`
```
architectnow
```
> or use `npx` as above without having to install `@architectnow/cli`
## Commands
Each command, when run the first time, will generate a `.architectnow/.json`
to store the options entered so the CLI will not ask for the information the next time it runs.
Make sure to run the CLI at the root level of your project. Ideally, where `package.json` is.
### Permissions
Generate a permissions TypeScript enum from an API endpoint that exposes permissions in the following format:
```json
{
"GroupingName": {
"ResourceName": "grouping.resource",
"ResourceName2": "grouping.resource2",
"ResourceNameItemName": "grouping.resource.item",
"ResourceNameItemName2": "grouping.resource.item2",
},
"GroupingName2": {
"ResourceName": "grouping2.resource",
"ResourceName2": "grouping2.resource2",
"ResourceNameItemName": "grouping2.resource.item",
"ResourceNameItemName2": "grouping2.resource.item2",
}
}
```
Generated TypeScript enum will be in the following format:
```typescript
export enum Permissions {
GroupingNameResourceName = "grouping.resource";
GroupingNameResourceName2 = "grouping.resource2";
// ...
}
```
```
architectnow permissions
architectnow p
```
- Command name: `permissions`
- Alias: `p`
- Options:
- `url`: The API Endpoint to fetch the Permissions JSON
- `outputPath`: Where to store the generated enum
- `outputName`: The generated enum file name (default: `permissions.ts`)
### Lokalise
Generate translation files in JSON format depending on the languages set on the Lokalise project. A TypeScript interface will also be generated to accompany the translations.
```
architectnow lokalise
architectnow l
```
- Command name: `lokalise`
- Alias: `l`
- Options:
- `apiKey`: Lokalise API Key
- `projectId`: Project ID on Lokalise
- `translationsOutputPath`: Where to store the generated translations JSON files (default: `src/assets/i18n`)
- `interfaceOutputPath`: Where to store the generated TypeScript interface (default: `src`)
- `interfaceOutputName`: The generated interface file name (default: `translations.types.ts`)
- Plural key: `_plural` (eg: `activity` and `activity_plural`)