@izettle/javascript-env

javascript-env

Deprecation notice: We had a good run but javascript-env is no longer used or maintained by iZettle.

A collection of programs and configuration files that is meant to be shared between our JavaScript projects.

Install

$ npm install git+ssh://[e-mail]:iZettle/javascript-env.git

Usage

Run a program from command line:

$ `npm bin`/javascript-env [programName] [args]

or from your package.json:

{
  "scripts": {
    "lint": "javascript-env [programName] [args]"
  }
}

Everything following the programName will be passed as arguments to the program. So check the documentation of the program to find out what it can do.

To configure javascript-env put a javascript-env.js in your project's root directory. Each program as it's own section it this config file. There's an example config you can look at to get the idea.

Programs

The following programs exist currently:

format - one code style to rule them all

Uses prettier to reformat all source code.

Configure what files to reformat in your javascript-env.js config:

module.exports = {
  format: {
    files: "src/**/*.js"
  }
}

Pre-commit hook

To auto-format all files when commiting, do the following in the project you're using javascript-env in. Auto-formating on commit adds only takes a few milliseconds (for realz!) and it can't fail, so no reason to not do it.

Install husky and lint-staged.

yarn add husky lint-staged --dev

Add the following to your package.json

  "scripts": {
    "precommit": "lint-staged",
  },
  "lint-staged": {
    "*.js": [
      "javascript-env format --files",
      "git add"
    ]
  },

Now when committing, the files are automagically reformated!

lint - second code style to rule them all

Uses eslint and the programs/lint/.eslintrc rule file and the files glob specified in your javascript-env.js config file. Any other arguments supplied will just be passed to eslint.

Configure what files to lint by specifing it in your projects javascript-env.js config file.

module.exports = {
  lint: {
    files: "**/*.js"
  }
}

And run it like so:

$ javascript-env lint

You can make the Atom linter-eslint package use this projects .eslintrc file by putting ./node_modules/javascript-env/programs/lint/.eslintrc into the .eslintrc Path text field.

sasslint

Uses sass-lint and the programs/sasslint/.sass-lint.yml rule file. Will check linting on all files named *.scss and *.sass except files in node_modules. Any arguments supplied will just be passed to sass-lint.

Run it like

$ javascript-env sasslint

compile - 'cause configuring webpack is a pain

Gives us the ability to use es2015 and jsx without the hassle of setting up and configuring seventyeleven packages.

The only thing you need to get started is to specify entry and output in the compile section of your javascript-env.js file.

module.exports = {
  compile: {
    entry: "./path/to/entry-file.js",
    output: {
      path: "./path/to/output-dir",
      filename: "[chunkhash].[name].js"
    }
  }
}

Have a look at the example config to find out about all the configuration options. There's however one thing that the example config does not describe, which is the possibility to have multiple compile configs in your javascript-env.js file. This is done by setting the value of the compile section to an array of configs rather that just one:

module.exports = {
  compile: [{
    target: "web",
    useForTest: true,
    entry: "./path/to/entry-file.js",
    output: {
      path: "./path/to/output-dir",
      filename: "[chunkhash].[name].js"
    }
  }, {
    target: "node",
    entry: "./path/to/node-entry-file.js",
    output: {
      path: "./path/to/output-dir",
      filename: "[chunkhash].[name].js"
    }
  }]
}

These multiple builds will run in parallell thank you very much. One thing to note here is that when running tests we can only use one config. What config to use is determined by useForTest, if multiple useForTest is found the first one will be used.

There's a simple CLI for this program as well.

• $ javascript-env compile - A one-off run (runs all of your configs)
• $ javascript-env compile --production - Same as above but does compression, minification, deduping and so on.
• $ javascript-env compile --watch - Compiles and then watches for changes and recompiles when they happen
• $ javascript-env compile --dev-server - Starts a webpack dev server
• $ javascript-env compile --profile - Writes a webpack-stats-0.json file to the project root folder. Upload it to the webpack analyze tool find out about big dependencies or slow build performance. If you have multiple builds configured in your javascript-env.js config file, one file per config will be written.

Requiring Compile With Webpack [Advanced]

compile/compile-with-webpack can be required from another program, e.g:

const javascriptEnvConfig = require("./javascript-env").compile
const compileWithWebpack = require("@izettle/javascript-env/programs/compile/compile-with-webpack")

compileWithWebpack(javascriptEnvConfig, ["--return-config"])

Arguments

--return-config - Will tell the program not run the actual compilation but rather only return the final Webpack config. For using the config with external tools. Can also be used with "build mode" arguments such as --production, --dev-server, etc. E.g. compileWithWebpack(javascriptEnvConfig, ["--production", "--return-config"]).

Route base code splitting

// routes.js
import App from "Modules/App"

export default {
  path: "/",
  component: App,
  getChildRoutes(_, cb) {
    Promise.all([
      System.import("Modules/PageA/routes"),
      System.import("Modules/PageB/routes"),
    ])
    .then(modules => modules.reduce(acc, cur), acc.concat([cur.default]), [])
    .then(modules => cb(null, modules))
    .catch(err => console.error(err))
  }
}

// Modules/PageA/routes.js
export default {
  path: "/pageA",

  getComponent(_, cb) {
    System.import("./containers/page")
      .then(comp => cb(null, comp.default))
      .catch(err => console.log(err))
  }
}

// Modules/PageB/routes.js
export default {
  path: "/pageB",

  getComponent(_, cb) {
    System.import("./containers/index")
        .then(comp => cb(null, comp.default))
        .catch(err => console.log(err))
  },

  indexRoute: {
    getComponent(_, cb) {
      System.import("./containers/list")
        .then(comp => cb(null, comp.default))
        .catch(err => console.log(err))
    }
  },

  childRoutes: [{
    path: ":id",
    getComponent(_, cb) {
      System.import("./containers/show")
        .then(comp => cb(null, comp.default))
        .catch(err => console.log(err))
    }
  }, {
    path: ":id/edit",
    getComponent(_, cb) {
      System.import("./containers/edit")
        .then(comp => cb(null, comp.default))
        .catch(err => console.log(err))
    }
  }]
}

// index.js
import React from "react"
import ReactDOM from "react-dom"
import { Router } from "react-router/es6"
import routes from "./routes"

ReactDOM.render(
  <Provider store={store}>
    <Router routes={routes} />
  </Provider>,
  targetElement
)

:ring: :fish_cake: :dart: