Configure Prettier. Adapt the Travis setup. (#80)

* Configure Prettier. Adapt the Travis setup.

* Fix

Author: dunglas

.eslintrc.js

@@ -6,12 +6,16 @@ module.exports = {
   },
   'parser': 'babel-eslint',
   'parserOptions': {
-    ecmaVersion: 7,
-    sourceType: 'module'
+    'ecmaVersion': 7,
+    'sourceType': 'module'
   },
   'plugins': ['import'],
-  'extends': 'eslint:recommended',
-  'rules':{
+  'extends': [
+    'plugin:prettier/recommended',
+    'eslint:recommended',
+  ],
+  'rules': {
+    'prettier/prettier': 'error',
     'no-console': 0,
   }
 };

.travis.yml

@@ -1,7 +1,7 @@
 language: node_js
 node_js:
+- '10'
 - '8'
-- '7'
 - '6'
 
 cache:

package.json

@@ -25,8 +25,11 @@
     "babel-preset-es2015": "^6.24.0",
     "babel-preset-stage-0": "^6.22.0",
     "eslint": "^3.18.0",
+    "eslint-config-prettier": "^2.9.0",
     "eslint-plugin-import": "^2.2.0",
+    "eslint-plugin-prettier": "^2.6.0",
     "jest": "^23",
+    "prettier": "^1.13.2",
     "tmp": "^0.0.31"
   },
   "dependencies": {
@@ -43,6 +46,8 @@
   "scripts": {
     "test": "jest",
     "lint": "eslint src",
+    "fix": "eslint --fix src",
+    "eslint-check": "eslint --print-config .eslintrc.js | eslint-config-prettier-check",
     "build": "babel src -d lib --ignore '*.test.js'",
     "watch": "babel --watch src -d lib --ignore '*.test.js'",
     "test-gen": "rm -rf ./tmp && npm run build && ./lib/index.js  https://demo.api-platform.com ./tmp/react && ./lib/index.js https://demo.api-platform.com ./tmp/react-native -g react-native && ./lib/index.js https://demo.api-platform.com ./tmp/vue -g vue && ./lib/index.js https://demo.api-platform.com ./tmp/admin-on-rest -g admin-on-rest",

src/generators.js

@@ -1,24 +1,25 @@
-import AdminOnRestGenerator from './generators/AdminOnRestGenerator';
-import ReactGenerator from './generators/ReactGenerator';
-import ReactNativeGenerator from './generators/ReactNativeGenerator';
-import TypescriptInterfaceGenerator from './generators/TypescriptInterfaceGenerator';
-import VueGenerator from './generators/VueGenerator';
+import AdminOnRestGenerator from "./generators/AdminOnRestGenerator";
+import ReactGenerator from "./generators/ReactGenerator";
+import ReactNativeGenerator from "./generators/ReactNativeGenerator";
+import TypescriptInterfaceGenerator from "./generators/TypescriptInterfaceGenerator";
+import VueGenerator from "./generators/VueGenerator";
 
-function wrap (cl) {
-  return ({hydraPrefix, templateDirectory}) => new cl({hydraPrefix, templateDirectory})
+function wrap(cl) {
+  return ({ hydraPrefix, templateDirectory }) =>
+    new cl({ hydraPrefix, templateDirectory });
 }
 
-export default function generators (generator = 'react') {
+export default function generators(generator = "react") {
   switch (generator) {
-    case 'admin-on-rest':
+    case "admin-on-rest":
       return wrap(AdminOnRestGenerator);
-    case 'react':
+    case "react":
       return wrap(ReactGenerator);
-    case 'react-native':
+    case "react-native":
       return wrap(ReactNativeGenerator);
-    case 'typescript':
+    case "typescript":
       return wrap(TypescriptInterfaceGenerator);
-    case 'vue':
-      return wrap(VueGenerator)
+    case "vue":
+      return wrap(VueGenerator);
   }
 }

src/generators/AdminOnRestGenerator.js

@@ -1,33 +1,37 @@
-import fs from 'fs';
-import BaseGenerator from './BaseGenerator';
-import handlebars from 'handlebars';
-import hbh_comparison from 'handlebars-helpers/lib/comparison';
+import fs from "fs";
+import BaseGenerator from "./BaseGenerator";
+import handlebars from "handlebars";
+import hbh_comparison from "handlebars-helpers/lib/comparison";
 
 export default class extends BaseGenerator {
   constructor(params) {
     super(params);
 
     this.registerTemplates(`admin-on-rest/`, [
-      'components/foo.js',
-      'config/foo.js',
-      'resources/foo.js',
-      'resource-import.js',
+      "components/foo.js",
+      "config/foo.js",
+      "resources/foo.js",
+      "resource-import.js"
     ]);
 
-    handlebars.registerHelper('compare', hbh_comparison.compare);
+    handlebars.registerHelper("compare", hbh_comparison.compare);
   }
 
   help(resource) {
-    console.log('Code for the "%s" resource type has been generated!', resource.title);
+    console.log(
+      'Code for the "%s" resource type has been generated!',
+      resource.title
+    );
   }
 
   appendFile(template, dest, context = {}) {
-      fs.appendFileSync(dest, this.templates[template](context));
+    fs.appendFileSync(dest, this.templates[template](context));
   }
 
   generate(api, resource, dir) {
     const lc = resource.title.toLowerCase();
-    const titleUcFirst = resource.title.charAt(0).toUpperCase() + resource.title.slice(1);
+    const titleUcFirst =
+      resource.title.charAt(0).toUpperCase() + resource.title.slice(1);
 
     const context = {
       title: resource.title,
@@ -37,25 +41,29 @@ export default class extends BaseGenerator {
       fields: resource.readableFields,
       formFields: this.buildFields(resource.writableFields),
       hydraPrefix: this.hydraPrefix,
-      titleUcFirst,
+      titleUcFirst
     };
 
     // Create directories
     // These directories may already exist
-    for (let dir of [`${dir}/config`, `${dir}/resources`, `${dir}/components/`]) {
+    for (let dir of [
+      `${dir}/config`,
+      `${dir}/resources`,
+      `${dir}/components/`
+    ]) {
       this.createDir(dir, false);
     }
 
     for (let pattern of [
-      'components/%s.js',
-      'config/%s.js',
-      'resources/%s.js',
+      "components/%s.js",
+      "config/%s.js",
+      "resources/%s.js"
     ]) {
-      this.createFileFromPattern(pattern, dir, lc, context)
+      this.createFileFromPattern(pattern, dir, lc, context);
     }
 
-    this.appendFile('resource-import.js', `${dir}/resource-import.js`, context);
+    this.appendFile("resource-import.js", `${dir}/resource-import.js`, context);
 
-    this.createEntrypoint(api.entrypoint, `${dir}/config/_entrypoint.js`)
+    this.createEntrypoint(api.entrypoint, `${dir}/config/_entrypoint.js`);
   }
 }

src/generators/AdminOnRestGenerator.test.js

@@ -1,46 +1,48 @@
-import Api from '@api-platform/api-doc-parser/lib/Api';
-import Resource from '@api-platform/api-doc-parser/lib/Resource';
-import Field from '@api-platform/api-doc-parser/lib/Field';
-import fs from 'fs';
-import tmp from 'tmp';
-import AdminOnRestGenerator from './AdminOnRestGenerator';
+import Api from "@api-platform/api-doc-parser/lib/Api";
+import Resource from "@api-platform/api-doc-parser/lib/Resource";
+import Field from "@api-platform/api-doc-parser/lib/Field";
+import fs from "fs";
+import tmp from "tmp";
+import AdminOnRestGenerator from "./AdminOnRestGenerator";
 
-test('Generate a Admin On Rest app', () => {
-  const generator = new AdminOnRestGenerator({hydraPrefix: 'hydra:', templateDirectory: `${__dirname}/../../templates`});
-  const tmpobj = tmp.dirSync({unsafeCleanup: true});
+test("Generate a Admin On Rest app", () => {
+  const generator = new AdminOnRestGenerator({
+    hydraPrefix: "hydra:",
+    templateDirectory: `${__dirname}/../../templates`
+  });
+  const tmpobj = tmp.dirSync({ unsafeCleanup: true });
 
-  const fields = [new Field('bar', {
-    id: 'http://schema.org/url',
-    range: 'http://www.w3.org/2001/XMLSchema#string',
-    reference: null,
-    required: true,
-    description: 'An URL'
-  })];
-  const resource = new Resource('abc', 'http://example.com/foos', {
-    id: 'abc',
-    title: 'abc',
+  const fields = [
+    new Field("bar", {
+      id: "http://schema.org/url",
+      range: "http://www.w3.org/2001/XMLSchema#string",
+      reference: null,
+      required: true,
+      description: "An URL"
+    })
+  ];
+  const resource = new Resource("abc", "http://example.com/foos", {
+    id: "abc",
+    title: "abc",
     readableFields: fields,
     writableFields: fields
   });
-  const api = new Api('http://example.com', {
-    entrypoint: 'http://example.com:8080',
-    title: 'My API',
+  const api = new Api("http://example.com", {
+    entrypoint: "http://example.com:8080",
+    title: "My API",
     resources: [resource]
   });
   generator.generate(api, resource, tmpobj.name);
 
   [
-    '/config/_entrypoint.js',
-    '/resources/abc.js',
-    '/resource-import.js',
-  ].forEach(file => expect(fs.existsSync(tmpobj.name+file)).toBe(true));
+    "/config/_entrypoint.js",
+    "/resources/abc.js",
+    "/resource-import.js"
+  ].forEach(file => expect(fs.existsSync(tmpobj.name + file)).toBe(true));
 
-  [
-    '/components/abc.js',
-    '/config/abc.js',
-  ].forEach(file => {
-    expect(fs.existsSync(tmpobj.name+file)).toBe(true)
-    expect(fs.readFileSync(tmpobj.name+file, 'utf8')).toMatch(/bar/);
+  ["/components/abc.js", "/config/abc.js"].forEach(file => {
+    expect(fs.existsSync(tmpobj.name + file)).toBe(true);
+    expect(fs.readFileSync(tmpobj.name + file, "utf8")).toMatch(/bar/);
   });
 
   tmpobj.removeCallback();

src/generators/BaseGenerator.js

@@ -1,22 +1,26 @@
-import fs from 'fs';
-import handlebars from 'handlebars';
-import mkdirp from 'mkdirp';
-import { sprintf } from 'sprintf-js';
-import urlapi from 'url';
+import fs from "fs";
+import handlebars from "handlebars";
+import mkdirp from "mkdirp";
+import { sprintf } from "sprintf-js";
+import urlapi from "url";
 
 export default class {
   templates = {};
 
-  constructor({hydraPrefix, templateDirectory}) {
+  constructor({ hydraPrefix, templateDirectory }) {
     this.hydraPrefix = hydraPrefix;
     this.templateDirectory = templateDirectory;
 
-    this.registerTemplates('', ['_entrypoint.js']);
+    this.registerTemplates("", ["_entrypoint.js"]);
   }
 
   registerTemplates(basePath, paths) {
     for (let path of paths) {
-      this.templates[path] = handlebars.compile(fs.readFileSync(`${this.templateDirectory}/${basePath}${path}`).toString());
+      this.templates[path] = handlebars.compile(
+        fs
+          .readFileSync(`${this.templateDirectory}/${basePath}${path}`)
+          .toString()
+      );
     }
   }
 
@@ -31,7 +35,11 @@ export default class {
   }
 
   createFileFromPattern(pattern, dir, lc, context) {
-    this.createFile(sprintf(pattern, 'foo'), sprintf(`${dir}/${pattern}`, lc), context);
+    this.createFile(
+      sprintf(pattern, "foo"),
+      sprintf(`${dir}/${pattern}`, lc),
+      context
+    );
   }
 
   createFile(template, dest, context = {}, warn = true) {
@@ -46,41 +54,46 @@ export default class {
 
   createEntrypoint(apiEntry, dest) {
     const url = urlapi.parse(apiEntry);
-    const {protocol, host, pathname} = url;
-
-    this.createFile('_entrypoint.js', dest, {host: `${protocol}//${host}`, path: pathname}, false);
+    const { protocol, host, pathname } = url;
+
+    this.createFile(
+      "_entrypoint.js",
+      dest,
+      { host: `${protocol}//${host}`, path: pathname },
+      false
+    );
   }
 
   getHtmlInputTypeFromField(field) {
     switch (field.id) {
-      case 'http://schema.org/email':
-        return {type: 'email'};
+      case "http://schema.org/email":
+        return { type: "email" };
 
-      case 'http://schema.org/url':
-        return {type: 'url'};
+      case "http://schema.org/url":
+        return { type: "url" };
     }
 
     switch (field.range) {
-      case 'http://www.w3.org/2001/XMLSchema#integer':
-        return {type: 'number'};
+      case "http://www.w3.org/2001/XMLSchema#integer":
+        return { type: "number" };
 
-      case 'http://www.w3.org/2001/XMLSchema#decimal':
-        return {type: 'number', step: '0.1'};
+      case "http://www.w3.org/2001/XMLSchema#decimal":
+        return { type: "number", step: "0.1" };
 
-      case 'http://www.w3.org/2001/XMLSchema#boolean':
-        return {type: 'checkbox'};
+      case "http://www.w3.org/2001/XMLSchema#boolean":
+        return { type: "checkbox" };
 
-      case 'http://www.w3.org/2001/XMLSchema#date':
-        return {type: 'date'};
+      case "http://www.w3.org/2001/XMLSchema#date":
+        return { type: "date" };
 
-      case 'http://www.w3.org/2001/XMLSchema#time':
-        return {type: 'time'};
+      case "http://www.w3.org/2001/XMLSchema#time":
+        return { type: "time" };
 
-      case 'http://www.w3.org/2001/XMLSchema#dateTime':
-        return {type: 'dateTime'};
+      case "http://www.w3.org/2001/XMLSchema#dateTime":
+        return { type: "dateTime" };
 
       default:
-        return {type: 'text'};
+        return { type: "text" };
     }
   }
 
@@ -92,7 +105,7 @@ export default class {
       field.name = apiField.name;
       field.description = apiField.description.replace(/"/g, "'"); // fix for Form placeholder description
 
-      fields.push(field)
+      fields.push(field);
     }
 
     return fields;