Repox NPM | npm.io

Repox

Repox is a full integrated TypeScript monorepo system. It provides full support for multiple typescript projects.

1) Commands - Check version - Create workspace - Create project - Build project - Publish npm - Lint project

3) Other - List of programs - List of commands

Commands

Check version

To check the current version use the command below.

repox --version

You can use alias instead of argument.

repox -v

Create workspace

To create workspace use the command below.

repox generate workspace --name="example-workspace"

Arguments of generate workspace

Argument	Alias	Description	Required
--name	-n	Specify a workspace name	True

Create project

To create project use the command below.

repox generate project --name="example-project" --type="app" --scheme="@app/ts"

Arguments of generate project

Argument	Alias	Description	Required
--name	-n	Specify a project name	True
--type	-t	Specify a project type	True
--scheme	-s	Specify a project scheme	True
--path	-p	Specify a project path	False

Project type (--type argument) values

Type value	Description
app	Application project
lib	Library project
tool	Tool project

Project scheme (--scheme argument) values

Project scheme	Description
@blank	Blank project
@htmlpro	HTMLPRO project
@app/ts	TypeScript application
@lib/ts	TypeScript library
@tool/ts	TypeScript tool

Build project

To build project use the command below.

repox build project --name="example-project"

Arguments of build project

Argument	Alias	Description	Required
--name	-n	Specify a project name	True
--watch	-w	Build the project as soon as something changes	False
--production	-P	Turn on production build mode	False

Publish npm

To publish npm use the command below.

repox publish npm --name="example-project"

Arguments of publish npm

Argument	Alias	Description	Required
--name	-n	Specify a project name	True

Lint project

To lint project use the command below.

repox lint project

Arguments of generate project

Argument	Alias	Description	Required
--fix	-f	Fix issues during linting	False

Configurations

repox.json file

{
  // All projects in the monorepo workspace
  "projects": {
    // Application TypeScript project
    "example-project-app": {
      // Project name
      "name": "example-project-app",
      // Project type
      "type": "app",
      // Project path
      "path": "projects/apps/example-project-app",
       // Project src path
       "src": "projects/apps/example-project-app/src",
      // Project scheme
      "scheme": "@app/ts",
      // Build settings for project
      "build": {
        // The compilation output path
        "output": "dist/example-project-app",
        // The main typescript file
        "main": "projects/apps/example-project-app/src/main.ts",
        // Additional resources that will be copied after compilation
        "assets": [
          {
            // The path to the copied item
            "input": "projects/apps/example-project-app/package.json",
            // The path where the file should be copied
            "output": "dist/example-project-app"
          }
        ]
      }
    },
    // Library TypeScript project
    "example-project-lib": {
      // Project name
      "name": "example-project-lib",
      // Project type
      "type": "lib",
      // Project path
      "path": "projects/libs/example-project-lib",
       // Project src path
      "src": "projects/libs/example-project-lib/src",
      // Project scheme
      "scheme": "@lib/ts"
    },
    // Tool TypeScript project
    "example-project-tool": {
      // Project name
      "name": "example-project-tool",
      // Project type
      "type": "tool",
      // Project path
      "path": "projects/tool/example-project-tool",
      // Project path
      "src": "projects/tool/example-project-tool/src",
      // Project scheme
      "scheme": "@tool/ts"
    }
  }
}