@oak-digital/types-4-strapi-2 0.2.7 → 0.2.8

package/README.md

@@ -1,16 +1,19 @@
 # types-4-strapi-2
 
-types-4-strapi-2 is a typescript program that will generate typescript types for your strapi projects.
-This can be useful if you have a frontend written with typescript to make sure you are using the correct types and can help report errors at compile time.
+types-4-strapi-2 is a TypeScript program that will generate TypeScript types for your strapi projects.
+This can be useful if you have a frontend written with TypeScript to make sure you are using the correct types and can help report errors at compile time.
 
-types-4-strapi-2 is a rewrite of (francescolorenzetti/types-4-strapi)[https://github.com/francescolorenzetti/types-4-strapi] written in typescript, with the goal of being much easier to extend and maintain.
+types-4-strapi-2 is a rewrite of [francescolorenzetti/types-4-strapi](https://github.com/francescolorenzetti/types-4-strapi) written in TypeScript, with the goal of being much easier to extend and maintain.
 
 ## Getting started
 
 Install the script for your project:
 
 ```bash
+# NPM
 npm install --save-dev @oak-digital/types-4-strapi-2
+# YARN
+yarn add -D @oak-digital/types-4-strapi-2
 ```
 
 Then set up a script in your `package.json`
@@ -38,8 +41,8 @@ This can be done with the `--out` flag like in the following example.
 
 ## Features
 
-* Generate typescript interfaces for all your api content-types and components
-* Generate typescript interfaces for builtin types such as `Media` and `MediaFormat`
+* Generate TypeScript interfaces for all your api content-types and components
+* Generate TypeScript interfaces for builtin types such as `Media` and `MediaFormat`
 * Select input and output directory
 * Prettier formatting and ability to use your own `.prettierrc`.
 
@@ -50,13 +53,14 @@ This can be done with the `--out` flag like in the following example.
 
 ## Flags
 
-| **flag**                    | **Description**                                                                    |
-|-----------------------------|------------------------------------------------------------------------------------|
-| -i, --in <dir>              | The src directory for strapi                                                       |
-| -o, --out <dir>             | The output directory to output the types to                                        |
-| --component-prefix <prefix> | A prefix for components                                                            |
-| -D, --delete-old            | CAUTION: This option is equivalent to running rm -rf on the output directory first |
-| --prettier <file>           | The prettier config file to use for formatting typescript interfaces               |
+| **Flag**                    | **Description**                                                                      | **Default** |
+|-----------------------------|--------------------------------------------------------------------------------------|-------------|
+| -i, --in <dir>              | The src directory for strapi                                                         | `./src`     |
+| -o, --out <dir>             | The output directory to output the types to                                          | `./types`   |
+| -prefix                     | A prefix for all generated interfaces                                                | `I`         |
+| --component-prefix <prefix> | A prefix for components                                                              | none        |
+| -D, --delete-old            | CAUTION: This option is equivalent to running `rm -rf` on the output directory first | `false`     |
+| --prettier <file>           | The prettier config file to use for formatting TypeScript interfaces                 | none        |
 
 ## Building
 
@@ -66,7 +70,7 @@ To build this project, use the following command
 npm run build
 ```
 
-## Publihsing
+## Publishing
 
 ```bash
 npm run build

package/lib/index.js

@@ -10,6 +10,7 @@ commander_1.program
 commander_1.program
     .option('-i, --in <dir>', 'The src directory for strapi', './src')
     .option('-o, --out <dir>', 'The output directory to output the types to', './types')
+    .option('--prefix <prefix>', 'A prefix for all generated interfaces', 'I')
     .option('--component-prefix <prefix>', 'A prefix for components', '')
     .option('-D, --delete-old', 'CAUTION: This option is equivalent to running rm -rf on the output directory first')
     .option('--file-case <case>', 'Which case to use for generated files', 'pascal')
@@ -17,9 +18,10 @@ commander_1.program
     .option('--prettier <file>', 'The prettier config file to use for formatting typescript interfaces');
 commander_1.program.parse();
 var options = commander_1.program.opts();
-var input = options.in, out = options.out, componentPrefix = options.componentPrefix, prettierFile = options.prettier, deleteOld = options.deleteOld, fileCaseType = options.fileCase, folderCaseType = options.folderCase;
+var input = options.in, out = options.out, componentPrefix = options.componentPrefix, prefix = options.prefix, prettierFile = options.prettier, deleteOld = options.deleteOld, fileCaseType = options.fileCase, folderCaseType = options.folderCase;
 var manager = new InterfaceManager_1.default(out, input, {
     componentPrefix: componentPrefix,
+    prefix: prefix,
     prettierFile: prettierFile,
     deleteOld: deleteOld,
     fileCaseType: fileCaseType,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oak-digital/types-4-strapi-2",
-  "version": "0.2.7",
+  "version": "0.2.8",
   "description": "Typescript interface generator for Strapi 4 models",
   "bin": {
     "t4s": "./bin/index.js"