@mara/cli NPM | npm.io

Marauder

挖掘机技术哪家强

Marauder 下一代工程化体系。

Quick Overview

npx @mara/create my-app
cd my-app
yarn dev

npx 依赖 npm v5.2 及更高版本

新建项目

依赖 node 8.10.0+

Marauder 支持多种项目生成方式，以下命令均可一键生成 Vue + Typescript 项目：

npx（推荐）

npx @mara/create my-app

需要 npm 5.2+ 版本

npm

npm init @mara my-app

需要 npm 6+ 版本

yarn

yarn create @mara my-app

需要 yarn 0.25+ 版本

Marauder CLI

npm i @mara/cli -g

mara create my-app

选择模板

Marauder 预设 Vue 及 React 模板，可通过 --preset | -p 参数指定。

默认情况下创建 Vue + Typescript 项目:

npx @mara/create my-app

创建 React + Typescript 项目:

npx @mara/create my-app -p react

Vanilla Js 模板

当 --preset 参数指定其他非预设值时，将应用 Vanilla Js 模板

使用 zepto:

npx @mara/create my-app --preset zepto --no-ts

不使用任何类库：

npx @mara/create my-app --preset --no-ts

完整的命令行参数有：

--use-npm 使用 npm 安装依赖，默认 yarn
--use-pnp 使用 yarn pnp 模式
--no-ts 不使用 typescript
--preset | -p 指定预设模板，vue | react | other lib
--force | -f 强制在指定目录生成项目

项目结构

通过 marauder 创建的项目具有以下典型结构：

my-app
├── README.md
├── node_modules
├── package.json
├── marauder.config.js
├── .gitignore
└── src
    └── views  # 视图目录
        ├── home  # 页面
        │   ├── index.js
        │   └── index.html
        └── profile  # 页面
            ├── index.js
            └── index.html

视图目录

marauder 为多页打包工具，我们约定 src/views 为视图目录，视图目录用于存放页面。

页面

我们把视图目录下，含有入口脚本和入口文档文件的目录称为页面。我们约定入口脚本与入口文档以 index 命名。

可识别为入口脚本的文件有：

index.js
index.ts
index.jsx
index.tsx

当同时存在多个入口脚本时，遵循以下加载顺序：

ts > tsx > js > jsx

入口文档：index.html

页面示例：

views
├── home  # home 页面
│   ├── index.js
│   └── index.html
└── profile  # profile 页面
│   ├── index.ts
│   └── index.html
└── other  # 非页面，缺少入口脚本
    ├── foo.js
    └── index.html

上述示例中 home 和 profile 目录含有入口脚本与入口文档，因此被识别为页面。 other 目录仅含有入口文档，缺少入口脚本，因此不是页面。