pmnps

pmnps is a monorepo tool, it uses npm workspaces to manage packages and platforms.

Other language

中文

Install

npm install pmnps -g

or

npm install pmnps --save-dev

Basic usage

use pmnps

$ pmnps

after running:

- project
  - node_modules
  - packages
  - plats
  package.json
  .pmnpsrc.json

This command can create a monorepo project and install the dependencies & devDependencies into root node_modules.

use create command

create a package

$ pmnps create package -n test

after running:

- project
  - node_modules
  - packages
    - test
      - src
      index.ts
      package.json
  - plats
  package.json
  .pmnpsrc.json

create a platform

$ pmnps platform -n web-test

after running:

- project
  - node_modules
  - packages
    - test
      - src
      index.ts
      package.json
  - plats
    - web-test
      -src
        index.tsx
      package.json
  package.json
  .pmnpsrc.json

This command can add a package or a platform, and install the dependencies & devDependencies into root node_modules.

use refresh command

$ pmnps refresh

after running:

- project
  - node_modules
  - packages
    - test
      - src
      index.ts
      package.json
  - plats
    - web-test
      -src
        index.tsx
      package.json
  package.json
  .pmnpsrc.json

This command can install all the dependencies and devDependencies from packages and platforms into the root node_modules.

use start command

The start command can start a platform development. It runs npm start command in platform package.json > scripts.start.

$ pmnps start

or

$ pmnps start -n <platform>

use build command

The build command can build platforms. It runs npm run build command in platform package.json > scripts.build.

# build all platforms
$ pmnps build

or

# build a special platform
$ pmnps build -n <platform name>

If you want to build with a mode you set with command config, you can use option param -m <mode>.

$ pmnps build -n <platform name> -m <mode>

If you want to install dependencies before build, you can use option param -i.

$ pmnps build -n <platform name> -m <mode> -i

If you want to add param to npm build script, you can use option param -p <param>.

$ pmnps build -p "-i -e <param desc>"

Notice, the usage about -p below is global for all building platforms, if you want assign the params to platforms which you want params work on, you can use the url query param to replace it.

# it looks like url query param "?name1=param1&name2=param2"
$ pmnps build -p "?platA= -i -e <param desc>&platB= -i"

use config command

The config command allows you to do more configs. You can open git usage, rename workspace and add build mode for your project. The build mode is a string word which will be added into your package.json > scripts like scripts.build-<mode>, when you use command build with option -m <mode>, it runs npm run build-<mode> script.

$ pmnps config

options:

rename workspace              # rename the workspace name
active/disable git            # active or disable git usage
lock/unlock                   # lock or unlock the config
package build strict/loose    # the package create mode
private/public project        # set packages or platforms 'private'

The package build mode loose, creates a index file directly in the root dir of package, that means you can use this package as a module in your platform project, and it does not need to build alone, you can build the platform directly, just like the package dependence is just a part module in platform.

The package build mode strict, creates a index file in a src dir. If you are using typescript, you may find that almost all the popular code editors can not find the dependency codes from package, but it works well, so, you have to write index.d.ts file to resolve this problem. And in this mode, you can build packages and publish it into npm manually.

use template command

The template command can help you build some templates for packages and plats. When you use pack or plat command to build a project, it can be helpful.

$ pmnps template

use publish command

The publish command can help you publish the packages and platforms.

$ pmnps publish

If you have set one password, please use -o to pass it in.

$ pmnps publish -o 123456

Package.json config

Now, you can add pmnps property into your package.json in platforms or packages.

platform config platDependencies

Add pmnps.platDependencies config to describe the build dependencies in platforms.

platA -> package.json

{
  "private": true,
  "name": "platA",
  "version": "0.0.1",
  "scripts": {
    "start": "...start",
    "build": "... build",
    "build-inside": ".... build inside mode" 
  },
  "pmnps": {
    "platDependencies": [
      "platB"
    ]
  }
}

platB -> package.json

{
  "private": true,
  "name": "platB",
  "version": "0.0.1",
  "scripts": {
    "start": "...start",
    "build": "... build",
    "build-inside": ".... build inside mode" 
  },
  "pmnps": {
    "platDependencies": [
      "platC"
    ]
  }
}

platC -> package.json

{
  "private": true,
  "name": "platC",
  "version": "0.0.1",
  "scripts": {
    "start": "...start",
    "build": "... build",
    "build-inside": ".... build inside mode" 
  }
}

So, when use command build, it will follow the platDependencies build one by one, build platC -> build platB -> build platA.

platform config ownRoot

Add pmnps.ownRoot config to describe a platform which installs node_modules in own root folder.

{
  "private": true,
  "name": "platB",
  "version": "0.0.1",
  "scripts": {
    "start": "...start",
    "build": "... build",
    "build-inside": ".... build inside mode" 
  },
  "pmnps": {
    "ownRoot": true
  }
}

platform config alias

Add pmnps.alias config to give your platform a alias name.

{
  "private": true,
  "name": "platB",
  "version": "0.0.1",
  "scripts": {
    "start": "...start",
    "build": "... build",
    "build-inside": ".... build inside mode" 
  },
  "pmnps": {
    "alias": "pb"
  }
}

The alias name can only works with build -p command option currently.

# it looks like url query param "?name1=param1&name2=param2"
$ pmnps build -p "?platA= -i -e <param desc>&platB= -i"

# use alias
$ pmnps build -p "?pb= -i"

platform config alias

pmnps.buildHook provides two synchronous scripts before and after hook to every platform building.

{
  "private": true,
  "name": "platB",
  "version": "0.0.1",
  "scripts": {
    "start": "...start",
    "build": "... build",
    "build-inside": ".... build inside mode" 
  },
  "pmnps": {
    "buildHook": {
      "before":"echo build start...",
      "after":"echo build end..."
    }
  }
}

Use build -p, we can provide params for before or after scripts.

$ pmnps build -p "?platB.before= -i -e <word>"

.pmnpsrc.json

The file pmnpsrc.json is the config file for whole root project, it contains workspace name, git usage, lock flag and plugins.

{
  "workspace": "workspace",
  "git": true,
  "lock": true,
  "plugins": ["pmnps-dependencies-detect-plugin"]
}

plugins

The plugins is added from pmnps@2.0.0, you can write plugins and publish them to npm, or pick the plugins you need, and config them in pmnpsrc.json file for usage.

{
  "workspace": "workspace",
  "git": true,
  "lock": true,
  "plugins": ["pmnps-dependencies-detect-plugin"]
}

And before config them, you should add the plugin into devDependencies in package.json file.

update

v2.0.0

• start -p changes to start -n
• pack command changes to package command
• plat command changes to platform command
• The root config pmnps.config.json changes to .pmnpsrc.json
• pmnps.pack.json & pmnps.plat.json is deprecated
• add simple plugin system.

v2.0.1

• smooth the all build process.

v2.0.2

• modify log name about all build process.

v2.0.3

• fix all build log at wrong position bug.

v2.0.4

• support parent config file finding.

v2.1.0

• deprecate the initial command.
• use create command to replace the old package and platform command.
• deprecate the global build mode config
• add the package build mode.

v2.1.1

• add publish command.

v2.1.2

• fix the problem that the prettier can not add to devDependencies.

v2.1.3

• make create platform have a build mode selection.

v2.1.4

• fix the problem about ctrl + c can not kill the pmnps start child process problem.

v2.1.5

• use SIGKILL to kill sub process.

v2.1.6

• listen to SIGTERM\SIGKILL\SIGINT for closing child process.

v2.1.7

• try to kill the windows npx start

v2.1.8

• fix the problem about windows can not kill child process.