rigjs 2.1.29 → 3.0.0-alpha

package/demo/package.json

@@ -13,9 +13,10 @@
   },
   "dependencies": {
     "core-js": "^3.8.3",
-    "vue": "^2.6.14",
+    "cross-env": "^7.0.3",
     "rig-test-1": "git+ssh://git@github.com:FlashHand/rig-test-1.git#1.0.1",
-    "rig-test-2": "git+ssh://git@github.com:FlashHand/rig-test-2.git#1.0.1"
+    "rig-test-2": "git+ssh://git@github.com:FlashHand/rig-test-2.git#1.0.2",
+    "vue": "^2.6.14"
   },
   "devDependencies": {
     "@babel/core": "^7.12.16",
@@ -25,8 +26,8 @@
     "@vue/cli-service": "~5.0.0",
     "eslint": "^7.32.0",
     "eslint-plugin-vue": "^8.0.3",
-    "vue-template-compiler": "^2.6.14",
-    "json5": "2.1.3"
+    "json5": "2.2.1",
+    "vue-template-compiler": "^2.6.14"
   },
   "eslintConfig": {
     "root": true,
@@ -49,6 +50,7 @@
   ],
   "workspaces": [
     "rigs/*",
-    "rigs_dev/*"
+    "rigs_dev/*",
+    "rig_dev/*"
   ]
-}
+}

package/demo/package.rig.json5

@@ -1,12 +1,66 @@
-[
-  {
-    name: "rig-test-1",
-    source: "git@github.com:FlashHand/rig-test-1.git",
-    version: "1.0.1",
+{
+  dependencies: {
+    'rig-test-1': {
+      dev: true,
+      name: 'rig-test-1',
+      source: 'git@github.com:FlashHand/rig-test-1.git',
+      version: '1.0.1',
+    },
+    'rig-test-2': {
+      dev: false,
+      name: 'rig-test-2',
+      source: 'git@github.com:FlashHand/rig-test-2.git',
+      version: '1.0.2',
+    },
   },
-  {
-    name: "rig-test-2",
-    source: "git@github.com:FlashHand/rig-test-2.git",
-    version: "1.0.2",
+  isLegacy: false,
+  cicd: {
+    path_schema: "demo/{env}/{oem}",
+    //Your local build's path.
+    source: {
+      root_path: "dist"
+    },
+    //Entry path for your website's index.html.Default is '/'.
+    web_entry_path: '/',
+    //Your deploy target
+    target: {
+      //Only support alicould for now.
+      id: "alicloud",
+      type: "alicloud",
+      bucket: "rys-deploy",
+      region: "oss-cn-hangzhou",
+      access_key: "${ak}",
+      access_secret: "${as}",
+      //Root path in the bucket,default is '/'.
+      root_path: "/",
+    },
+    endpoints: {
+      "demo/test/oem1": {
+        build: 'yarn cross-env OUTPUT_DIR=__RIG_OUTPUT_DIR__ PUBLIC_PATH=__RIG_PUBLIC_PATH__ vue-cli-service build',
+        defines: {
+          RIG_REPLACE_GRAY: '/test-gray'
+        },
+        domains: [
+          "test-mp.rys.cn"
+        ],
+      },
+    },
+    groups: [
+      {
+        name: "%oem",
+        level: "oem",
+        includes: [
+          "oem1",
+          "oem2"
+        ]
+      },
+    ]
+
   },
-]
+  share: {
+    eslint: {
+      links: ['https://gist.githubusercontent.com/FlashHand/580a0a2f13b5ec31ccbedd368abd3bbf/raw/0638841f4f0c284d442a7ffe7bc9c8f3f2feb91e/.eslintrc.js'],
+    }
+  }
+
+}

package/demo/rig_helper.js

@@ -1,14 +1,10 @@
 const json5 = require('json5');
 const fs = require('fs');
-const getPkgs = () => {
-	let pkgArr = json5.parse(fs.readFileSync('./package.rig.json5'));
-	let flatPkgArr = pkgArr.map((item, index) => {
-		return item.name;
-	});
-	console.log(flatPkgArr);
-	return flatPkgArr;
+const getRigDeps = () => {
+	let rigConfig = json5.parse(fs.readFileSync('./package.rig.json5'));
+	return Object.keys(rigConfig.dependencies);
 }
-
 module.exports = {
-	getPkgs
+	getPkgs: getRigDeps,
+	getRigDeps
 }

package/demo/vue.config.js

@@ -3,6 +3,6 @@ console.log(process.env.PUBLIC_PATH)
 
 module.exports = defineConfig({
   transpileDependencies: true,
-  outputDir: process.env.OUT_PUT_DIR,
+  outputDir: process.env.OUTPUT_DIR,
   publicPath: process.env.PUBLIC_PATH
 })

package/demo/yarn.lock

@@ -2345,6 +2345,13 @@ cosmiconfig@^7.0.0:
     path-type "^4.0.0"
     yaml "^1.10.0"
 
+cross-env@^7.0.3:
+  version "7.0.3"
+  resolved "https://registry.yarnpkg.com/cross-env/-/cross-env-7.0.3.tgz#865264b29677dc015ba8418918965dd232fc54cf"
+  integrity sha512-+/HKd6EgcQCJGh2PSjZuUitQBQynKor4wrFbRg4DtAgS1aWO+gU52xpH7M9ScGgXSYmAVS9bIJ8EzuaGw0oNAw==
+  dependencies:
+    cross-spawn "^7.0.1"
+
 cross-spawn@^5.0.1:
   version "5.1.0"
   resolved "https://registry.npmmirror.com/cross-spawn/-/cross-spawn-5.1.0.tgz#e8bd0efee58fcff6f8f94510a0a554bbfa235449"
@@ -2365,7 +2372,7 @@ cross-spawn@^6.0.0:
     shebang-command "^1.2.0"
     which "^1.2.9"
 
-cross-spawn@^7.0.2, cross-spawn@^7.0.3:
+cross-spawn@^7.0.1, cross-spawn@^7.0.2, cross-spawn@^7.0.3:
   version "7.0.3"
   resolved "https://registry.npmmirror.com/cross-spawn/-/cross-spawn-7.0.3.tgz#f73a85b9d5d41d045551c177e2882d4ac85728a6"
   integrity sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==
@@ -3797,12 +3804,10 @@ json-stable-stringify-without-jsonify@^1.0.1:
   resolved "https://registry.yarnpkg.com/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz#9db7b59496ad3f3cfef30a75142d2d930ad72651"
   integrity sha1-nbe1lJatPzz+8wp1FC0tkwrXJlE=
 
-json5@2.1.3:
-  version "2.1.3"
-  resolved "https://registry.yarnpkg.com/json5/-/json5-2.1.3.tgz#c9b0f7fa9233bfe5807fe66fcf3a5617ed597d43"
-  integrity sha512-KXPvOm8K9IJKFM0bmdn8QXh7udDh1g/giieX0NLCaMnb4hEiVFqnop2ImTXCc5e0/oHz3LTqmHGtExn5hfMkOA==
-  dependencies:
-    minimist "^1.2.5"
+json5@2.2.1:
+  version "2.2.1"
+  resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.1.tgz#655d50ed1e6f95ad1a3caababd2b0efda10b395c"
+  integrity sha512-1hqLFMSrGHRHxav9q9gNjJ5EXznIxGVO09xQRrwplcS8qs28pZ8s8hupZAmqDwZUmVZ2Qb2jnyPOWcDH8m8dlA==
 
 json5@^1.0.1:
   version "1.0.1"
@@ -5070,6 +5075,14 @@ reusify@^1.0.4:
   resolved "https://registry.npmmirror.com/reusify/-/reusify-1.0.4.tgz#90da382b1e126efc02146e90845a88db12925d76"
   integrity sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==
 
+"rig-test-1@git+ssh://git@github.com:FlashHand/rig-test-1.git#1.0.1":
+  version "1.0.1"
+  resolved "git+ssh://git@github.com:FlashHand/rig-test-1.git#9a86b587aa9bea6c176ab8a470c8a86e7a2bf655"
+
+"rig-test-2@git+ssh://git@github.com:FlashHand/rig-test-2.git#1.0.2":
+  version "1.0.2"
+  resolved "git+ssh://git@github.com:FlashHand/rig-test-2.git#3c158c6c86276e8b3b5e5c341c01f4f4d9ea6094"
+
 rimraf@^3.0.2:
   version "3.0.2"
   resolved "https://registry.npmmirror.com/rimraf/-/rimraf-3.0.2.tgz#f1a5402ba6220ad52cc1282bac1ae3aa49fd061a"

package/doc/cicd_cn.md

@@ -0,0 +1,120 @@
+# cicd
+### example:
+```json5
+{
+  cicd: {
+    path_schema: "demo/{env}/{oem}",
+    source: {
+      root_path: "dist",
+    },
+    web_entry_path: '/',
+    target: {
+      id: "alicloud",
+      type: "alicloud",
+      bucket: "deploy",
+      region: "oss-somewhere",
+      access_key: "${ak}",
+      access_secret: "${as}",
+      root_path: "/",
+    },
+    endpoints: {
+      "demo/test/oem1": {
+        build: 'yarn cross-env OUTPUT_DIR=__RIG_OUTPUT_DIR__ PUBLIC_PATH=__RIG_PUBLIC_PATH__ vue-cli-service build',
+        defines: {
+          RIG_REPLACE_GRAY: '/test-gray'
+        },
+        domains: [
+          "oem1.domain.com"
+        ],
+      },
+      "demo/test/oem2": {
+        build: 'yarn cross-env OUTPUT_DIR=__RIG_OUTPUT_DIR__ PUBLIC_PATH=__RIG_PUBLIC_PATH__ vue-cli-service build',
+        defines: {
+          RIG_REPLACE_GRAY: '/test-gray'
+        },
+        domains: [
+          "oem2.domain.com"
+        ],
+      },
+    },
+    groups: [
+      {
+        name: "%group1",
+        level: "oem",
+        includes: [
+          "oem1",
+          "oem2"
+        ]
+      },
+    ]
+  },
+}
+```
+|字段|说明|默认值|备注|
+|:---|:---|:---|:---|
+|path_schema|打包文件目录在source.root_path下前缀||
+|source.root_path|打包文件所在目录|dist|
+|web_entry_path|网站访问的根目录|/|有的网页首页不是用/直接访问，而是例如：https://domain.com/path_to_index|
+
+|target字段|说明|默认值|备注|
+|:---|:---|:---|:---|
+|id|目前暂无作用，部署目标的id,为多目标部署设计而预留|||
+|type|目前死为alicloud，部署目标的类型|alicloud||
+|bucket|ali-oss的bucket|
+|region|bucket的region|
+|access_key|oss访问授权| |${}的作用是该位置参数可以通过命令行配置，可以方式密钥暴露|
+|access_secret|oss访问授权| ||
+|root_path|bucket存放网站的根目录|/| |
+
+|endpoint字段|说明|默认值|备注|
+|:---|:---|:---|:---|
+|key|实际的路径前缀,必须符合path_schema|||
+|type|部署目标的类型，目前写死为alicloud|alicloud||
+|build|build脚本，必须将文件||需要将文件打包到__RIG_OUTPUT_DIR__下|
+|defines|预定义可替换字段||rig build完成后，会对所有的文本进行字段替换|
+|domains|需要部署的cdn域名||rig publish 会通过uri rewrite指向对应资源目录|
+
+#### path_schema
+rigjs 采用文件目录管理CICD.
+
+path_schema是文件打包目录前缀;
+
+在执行rig build|deploy|publish时，传入的路径的开头都必须符合path_schema.
+
+{}的作用是可变目录，在执行build|deploy|publish命令时可以指定该位置的目录名。
+可变目录使用比较灵活。
+
+#### rig build
+**example-1**
+通过-s 传入querystring，指定各位置的目录。
+```shell
+rig build demo/{env}/{oem}/1.1 -s env=test&oem=oem1
+#等价于
+rig build demo/test/oem1/1.0.0.0
+```
+**example-2**
+利用%通配符，同时打包到多个目录下
+```shell
+rig build demo/{env}/%/1.1 -s env=test
+#等价于
+rig build demo/test/oem1/1.0.0.0 && rig build demo/test/oem2/1.0.0.0
+```
+**注意：demo必须得写死，只有用{}包起来才是名称可变目录**
+
+#### rig deploy
+将代码发布到阿里云OSS中。
+```shell
+rig deploy demo/test/oem1/1.0.0.0 -p 'ak=your_access_token&as=your_access_secret'
+#-p的作用是用来替换${}参数。
+```
+#### rig publish
+将cdn回源到该目录下的网站，并刷新预热，完成后网页才算发布成功。
+```shell
+rig publish demo/test/oem1/1.0.0.0 -p 'ak=your_access_token&as=your_access_secret'
+```
+
+你可以在github或gitlab的cicd脚本中灵活使用build|deploy|publish命令，
+将不同环境或不同定制版的包打到不同目录下。
+另外path_schema可以帮助开发防止打包目录混乱的情况。
+
+

package/doc/dependencies_cn.md

@@ -0,0 +1,28 @@
+# dependencies
+
+```json5
+/*
+dev:
+  dev默认为false,为true时，执行yarn install,代码库会被clone
+source:
+  source是代码库的地址，目前只支持git ssh地址，暂时不支持http地址。
+version:
+  dev为false时生效，version指定tag的代码库的版本下载到node_modules中.
+  version支持semver格式,
+*/
+
+{
+  dependencies: {
+    'rig-test-1': {
+      dev: true,
+      source: 'git@github.com:FlashHand/rig-test-1.git',
+      version: '1.0.1',
+    },
+    'rig-test-2': {
+      dev: false,
+      source: 'git@github.com:FlashHand/rig-test-2.git',
+      version: '1.0.2',
+    },
+  }
+}
+```

package/doc/share_cn.md

@@ -0,0 +1,8 @@
+#Share
+```json5
+{
+  share: {
+    eslint: ['https://gist.githubusercontent.com/FlashHand/580a0a2f13b5ec31ccbedd368abd3bbf/raw/0638841f4f0c284d442a7ffe7bc9c8f3f2feb91e/.eslintrc.js'],
+  }
+}
+```

package/jest/test.rig.json5

@@ -0,0 +1,14 @@
+{
+  dependencies: {
+    'rig-test-1': {
+      dev: true,
+      name: 'rig-test-1',
+      source: 'git@github.com:FlashHand/rig-test-1.git',
+    },
+    'rig-test-2': {
+      dev: true,
+      name: 'rig-test-2',
+      source: 'git@github.com:FlashHand/rig-test-2.git',
+    },
+  },
+}

package/jest.config.ts

@@ -1,7 +1,16 @@
 const config = {
 	verbose: false,
 	collectCoverage: true,
-
+	preset: 'ts-jest',
+	testMatch: [
+		"**/?(*.)+(spec|test).+(ts|tsx|js)",
+	],
+	transform: {
+		"^.+\\.(ts|tsx)$": "ts-jest",
+	},
+	moduleNameMapper: {
+		'^@/(.*)$':'<rootDir>/lib/$1',
+	},
 };
 
 module.exports = config;

package/lib/add/index.ts

@@ -0,0 +1,37 @@
+import regexHelper from '../utils/regexHelper';
+import {Dep} from '@/classes/dependencies/Dep';
+import RigConfig from '@/classes/RigConfig';
+import install from '../install';
+import print from '../print';
+import semver from 'semver/preload';
+
+/**
+ * @desc add
+ * 安装rig库
+ * @returns {Promise<void>}
+ */
+export default async (cmd: any) => {
+	try {
+		print.info(`rig add`);
+		const rigConfig = RigConfig.createFromCWD();
+		if (rigConfig.isLegacy) throw new Error(`rig dev' does not support legacy config template`);
+		const cmdArgs = cmd.args;
+		//检查第一个参数是否是git url,第二个参数是否是版本号
+		if (regexHelper.gitURL.test(cmdArgs[0]) && semver.valid(cmdArgs[1])) {
+			//传入git url,模式2处理
+			const source = cmdArgs[0];
+			const gitName = source.match(regexHelper.matchGitName)[2];
+			print.info(`add ${gitName}(${source}) to dev`);
+			const dep = new Dep({name: gitName, source, dev: false, version: cmdArgs[1]});
+			rigConfig.findOrUpsertDep(gitName, dep);
+		} else {
+			throw new Error(`arg[0] needs to be git url;arg[1] needs to be semver`);
+		}
+		console.log('do overwritting');
+		rigConfig.overwrite();
+		console.log('do installing');
+		await install()
+	} catch (e) {
+		throw new Error(`rig add failed:${e.message}`);
+	}
+}

package/lib/build/build.md

@@ -0,0 +1,6 @@
+# build
+
+|pamameters|replacement|
+|:---|:---|
+|__RIG_PUBLIC_PATH__||
+|__RIG_ENTRY_PATH__||

package/lib/build/index.ts

@@ -4,7 +4,8 @@ import shell from 'shelljs';
 import path from 'path';
 import fs from 'fs';
 import vueEnv from '../vue-env';
-const print = require('../print');
+
+import print from '../print';
 
 const replaceDefine = (target: string, defines?: Define) => {
 	console.log(`start replaceDefine:${target}`);
@@ -30,68 +31,72 @@ const replaceDefine = (target: string, defines?: Define) => {
 	}
 }
 export default async (cmd: any) => {
-	try {
-		console.log('start building');
-		//create cicd object
-		const cicd = CICD.createByDefault(cmd);
-		//construct cmd object
-		const cicdCmd = new CICDCmd(cmd, cicd);
-		//build by cicdCmd and cicdConfig
-		if (cicdCmd.endpoints.length === 0) {
-			throw new Error('Must have validate endpoints')
-		}
-		//替换build中的可替换变量
-		const regexPublicPath = new RegExp('\\$public_path', 'g');
-		const regexPublicPath2 = new RegExp('__PUBLIC_PATH__', 'g');
-		const regexDomain = new RegExp('__DOMAIN__', 'g');
+	console.log('start building');
+	//create cicd object
+	const cicd = CICD.createByDefault(cmd);
+	//construct cmd object
+	const cicdCmd = new CICDCmd(cmd, cicd);
+	//build by cicdCmd and cicdConfig
+	if (cicdCmd.endpoints.length === 0) {
+		throw new Error('Must have validate endpoints')
+	}
+	//替换build中的可替换变量
+	const regexPublicPath = new RegExp('\\$public_path', 'g');
+	const regexPublicPath2 = new RegExp('__PUBLIC_PATH__', 'g');
+	const regexPublicPath3 = new RegExp('__RIG_PUBLIC_PATH__', 'g');
 
-		for (let i = 0; i < cicdCmd.endpoints.length; i++) {
-			const ep = cicdCmd.endpoints[i];
-			try {
-				//替换define中的$public_path
-				if (ep.defines){
-					Object.keys(ep.defines).forEach(key => {
-						ep.defines[key] = ep.defines[key].replace(regexPublicPath, ep.publicPath);
-						ep.defines[key] = ep.defines[key].replace(regexPublicPath2, ep.publicPath);
-						ep.defines[key] = ep.defines[key].replace(regexDomain, ep.domains[0]);
-					});
-				}
-			} catch (e) {
-				console.log('JSON5 error:', ep.defines, e.message);
-			}
-			let frameworktype: FrameworkType | undefined;
-			//判断是否要生成环境变量文件,以及生成环境变量的操作
-			if (ep.vue_env) {
-				frameworktype = FrameworkType.vue;
+	const regexDomain = new RegExp('__DOMAIN__', 'g');
+	const regexDomain2 = new RegExp('__RIG_DOMAIN__', 'g');
+	const regexOutput = new RegExp('__RIG_OUTPUT_DIR__', 'g');
+
+
+	for (let i = 0; i < cicdCmd.endpoints.length; i++) {
+		const ep = cicdCmd.endpoints[i];
+		try {
+			//替换define中的$public_path
+			if (ep.defines) {
+				Object.keys(ep.defines).forEach(key => {
+					ep.defines[key] = ep.defines[key].replace(regexPublicPath, ep.publicPath);
+					ep.defines[key] = ep.defines[key].replace(regexPublicPath2, ep.publicPath);
+					ep.defines[key] = ep.defines[key].replace(regexPublicPath3, ep.publicPath);
+					ep.defines[key] = ep.defines[key].replace(regexDomain, ep.domains[0]);
+					ep.defines[key] = ep.defines[key].replace(regexDomain2, ep.domains[0]);
+				});
 			}
-			if (!ep.extra_env) ep.extra_env = {};
-			ep.extra_env['PUBLIC_PATH'] = ep.publicPath;
-			ep.extra_env['OUTPUT_DIR'] = path.join(cicd.source.root_path, ep.publicPath);
+		} catch (e) {
+			console.log('JSON5 error:', ep.defines, e.message);
+		}
+		let frameworktype: FrameworkType | undefined;
+		//判断是否要生成环境变量文件,以及生成环境变量的操作
+		if (ep.vue_env) {
+			frameworktype = FrameworkType.vue;
+		}
+		if (!ep.extra_env) ep.extra_env = {};
+		ep.extra_env['PUBLIC_PATH'] = ep.publicPath;
+		ep.extra_env['OUTPUT_DIR'] = path.join(cicd.source.root_path, ep.publicPath);
 
-			switch (frameworktype) {
-				case FrameworkType.vue: {
-					vueEnv.useEnv(ep.vue_env!, ep.extra_env);
-					//推测vue脚本
-					if (!ep.build) ep.build = `npx @vue/cli-service build --mode rig --dest ${ep.extra_env['OUTPUT_DIR']}`;
-				}
-					break;
-				default:
-					break;
+		switch (frameworktype) {
+			case FrameworkType.vue: {
+				vueEnv.useEnv(ep.vue_env!, ep.extra_env);
+				//推测vue脚本
+				if (!ep.build) ep.build = `npx vue-cli-service build --mode rig --dest ${ep.extra_env['OUTPUT_DIR']}`;
 			}
-			ep.build = ep.build.replace(regexPublicPath, ep.publicPath);
-			print.info(`using build script:${ep.build}`);
-			shell.exec(ep.build);
-			//setup default defines and replace text in built source.
-			if (!ep.defines) ep.defines = {};
-			ep.defines['__PUBLIC_PATH__'] = ep.publicPath;
-			ep.defines['__DEPLOY_DIR__'] = ep.publicPath;
-			ep.defines['__RIG_PUBLIC_PATH__'] = ep.publicPath;
-			ep.defines['__RIG_DEPLOY_DIR__'] = ep.publicPath;
-			ep.defines['__RIG_ENTRY_PATH__'] = ep.web_entry_path!;
-			replaceDefine(path.join(cicd.source.root_path, ep.publicPath), ep.defines);
+				break;
+			default:
+				break;
 		}
-	} catch (e) {
-		console.error(e.message);
-		process.exit(1);
+		//Replace predefined variables in build script
+		ep.build = ep.build.replace(regexPublicPath, ep.publicPath);
+		ep.build = ep.build.replace(regexOutput, path.join(cicd.source.root_path, ep.publicPath));
+		print.info(`using build script:${ep.build}`);
+		shell.exec(ep.build);
+		//setup default defines and replace text in built source.
+		if (!ep.defines) ep.defines = {};
+		ep.defines['__PUBLIC_PATH__'] = ep.publicPath;
+		ep.defines['__DEPLOY_DIR__'] = ep.publicPath;
+		ep.defines['__RIG_PUBLIC_PATH__'] = ep.publicPath;
+		ep.defines['__RIG_DEPLOY_DIR__'] = ep.publicPath;
+		ep.defines['__RIG_ENTRY_PATH__'] = ep.web_entry_path!;
+		replaceDefine(path.join(cicd.source.root_path, ep.publicPath), ep.defines);
 	}
 }

package/lib/classes/RigConfig.test.ts

@@ -0,0 +1,14 @@
+import path from 'path';
+
+const testPath = path.join(__dirname, '../../jest/test.rig.json5');
+import RigConfig from '@/classes/RigConfig';
+
+test('RigConfig init dependencies', () => {
+	const testConfig = RigConfig.createFromPath(testPath);
+	expect(testConfig.dependencies).toEqual({
+			'rig-test-1': {
+				source: "git@github.com:FlashHand/rig-test-1.git",
+				version: "1.0.1"
+			}
+		});
+});