Merge pull request #3 from ScottLogic/simplify-tests

fix: formatter is now a JS module

Author: ColinEberhardt

README.md

@@ -1,11 +1,24 @@
 ## OpenAPI Forge - JavaScript
 
-This repository is the JavaScript template for the [OpenAPI Forge](https://github.com/ColinEberhardt/openapi-forge), see that repository for usage instructions:
+This repository is the JavaScript generator for the [OpenAPI Forge](https://github.com/ScottLogic/openapi-forge), see that repository for usage instructions:
 
 https://github.com/ScottLogic/openapi-forge
 
 ## Development
 
+### Running
+
+To run this generator, you also need to have [OpenAPI Forge] installed, or the repository checked out. Assuming you have it installed as a global module, you can run this generator as follows:
+
+```
+$ openapi-forge forge
+ \ https://petstore3.swagger.io/api/v3/openapi.json
+ \ .
+ \ -o api
+```
+
+This generates an API from the Pet Store swagger definition, using the generator within the current folder (`.`), outputting the results to the `api` folder.
+
 ### Testing
 
 The standard test script is used to execute the BDD-style tests against this generator.

formatter.js

@@ -0,0 +1,18 @@
+// there are issues with running prettier as a CLI command
+// see: https://github.com/ScottLogic/openapi-forge/issues/133
+// this is a workaround to run the prettier CLI as a node module
+const cli = require("prettier/cli.js");
+
+// map forge log levels to prettier log levels
+const logLevels = [
+  /* quiet */
+  "silent",
+  /* standard */
+  "warn",
+  /* verbose */
+  "debug",
+];
+
+module.exports = (folder, logLevel) => {
+  cli.run(["--write", folder, "--loglevel", logLevels[logLevel]]);
+};

package.json

@@ -11,7 +11,6 @@
     "test:generators": "\"./node_modules/.bin/cucumber-js\" -p generators",
     "format:check:all": "prettier --check .",
     "format:write:all": "prettier --write .",
-    "format:write": "prettier --write",
     "lint:check:all": "eslint .",
     "lint:write:all": "eslint --fix ."
   },

partials/modelIncludes.handlebars

@@ -1,4 +1,4 @@
-{{#if models}}
+{{#if models }}
 const {
   {{#each models}}{{@key}}, {{/each}}
 } = require("./model");