Lumos

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

Usage

$3

- package.json
- install @rajzik/lumos

Setup initial project with this package:

``bash
npm init
npm install --save-dev @rajzik/lumos
npx lumos-setup
`

yarn:

`bash
yarn init
yarn add --dev @rajzik/lumos
npx lumos-setup
`

Eject files

This will eject files and remove dependency of this package.

`bash
npx lumos-eject
`

Scaffold dotfile

`bash
npx lumos scaffold project dotfiles
`

Create configs

`bash
npx lumos create-config [driver list]
`

`bash
npx lumos create-config eslint prettier
`

Running drivers

`bash
npx lumos [--cli options]
`

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

Supported drivers

- babel
- danger
- eslint
- jest
- next
- prettier
- typescript
- webpack

$3

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

Supported settings

`ts
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;
nextTarget?: 'server' | 'serverless';
root?: string;
parallel?: boolean | string | number;
testResultFileName?: string;
emptyBabelConfig: boolean;
nextOptions?: Partial;
allowJs: boolean;
skipLibCheck: boolean;
}
`

$3

`ts
{
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',
}
`

$3

in package json

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

Modifying configs

$3

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

$3

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

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

Rest of documentation

Beemo docs