Package Exports

@oriflame/lumos

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@oriflame/lumos) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Lumos

Centralized CLI for JavaScript and TypeScript dev tools. Built on and powered by Beemo.

Usage

Prerequisites

package.json
install @oriflame/lumos

Setup initial project with this package:

npm init
npm install --save-dev @oriflame/lumos
npx lumos-setup

yarn:

yarn init
yarn add --dev @oriflame/lumos
npx lumos-setup

Eject files

This will eject files and remove dependency of this package.

npx lumos-eject

Scaffold dotfile

npx lumos scaffold project dotfiles

Create configs

npx lumos create-config [driver list]

npx lumos create-config eslint prettier

Running drivers

npx lumos <name of driver> [--cli options]

npx lumos eslint
npm lumos typescript --build --reference-workspaces

Supported drivers

Set drivers manually

{
  "lumos": {
    "drivers": ["babel", "eslint"]
  }
}

Supported settings

export interface LumosSettings {
  buildFolder: string;
  coverage: number;
  docsFolder: string;
  env: LumosEnvSetting;
  graphql: boolean;
  library: boolean;
  next: boolean;
  node: boolean;
  testingLibrary: boolean;
  react: boolean;
  srcFolder: string;
  testsFolder: string;
  typesFolder: string;
  entryPoint?: string;
  publicPath?: string;
  root?: string;
  parallel?: boolean | string | number;
  testResultFileName?: string;
  emptyBabelConfig: boolean;
  nextOptions?: Partial<NextConfigObject>;
  allowJs: boolean;
  skipLibCheck: boolean;
  host?: string;
}

Default values

{
  buildFolder: 'lib',
  coverage: 75,
  docsFolder: 'docs',
  env: {},
  graphql: false,
  library: false,
  next: false,
  node: false,
  react: false,
  testingLibrary: false,
  srcFolder: 'src',
  testsFolder: 'tests',
  typesFolder: 'types',
  emptyBabelConfig: false,
  allowJs: false,
  skipLibCheck: false,
  root: process.cwd(),
  parallel: true,
  testResultFileName: 'TEST-RESULTS.xml',
}

Edit this settings

in package json

{
  "lumos": {
    "settings": {
      "buildFolder": "lib",
      "coverage": 75
    }
  }
}

Modifying configs

Modify package.json

{
  "lumos": {
    "eslint": {
      // name of the driver
      "rules": {
        "import/prefer-default-export": "off"
      }
    }
  }
}

Create file in `configs` folder

Create javascript file inside this folder with name of driver. For example: configs/eslint.js

module.exports = {
  rules: {
    'import/prefer-default-export': 'off',
  },
};

Rest of documentation

Beemo docs

@oriflame/lumos