Chore: Update update-content.js

Update `update-content.js` to grab and render the docs of
the new monorepo architecture of the `sonarwhal` repository.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Close #390

Author: qzhou1607-zz

gulpfile.js

@@ -21,7 +21,7 @@ const dirs = {
 // ---------------------------------------------------------------------
 
 gulp.task('clean:before', (done) => {
-    shelljs.rm('-rf', dirs.dist, dirs.tmp);
+    shelljs.rm('-rf', dirs.dist, dirs.tmp, dirs.tmpContent);
 
     done();
 });

helpers/update-content.js

@@ -1,10 +1,10 @@
-/* global config cp exec rm */
-
+/* global config cp exec ls mv rm */
 const shell = require('shelljs/global'); // eslint-disable-line no-unused-vars
 
 const CLONE_URL = 'https://github.com/sonarwhal/sonarwhal.git'; // eslint-disable-line no-process-env
 const SOURCE_DIR = 'src/content';
 const TMP_DIR = require('./mktemp')();
+const PACKAGES_TMP_DIR = `${TMP_DIR}/packages`;
 
 config.fatal = true;
 
@@ -14,9 +14,18 @@ rm('-rf', `${SOURCE_DIR}/docs/contributor-guide`);
 rm('-rf', `${SOURCE_DIR}/docs/user-guide`);
 rm('-rf', `${SOURCE_DIR}/about`);
 
-cp('-R', `${TMP_DIR}/docs/contributor-guide`, `${SOURCE_DIR}/docs/contributor-guide`);
-cp('-R', `${TMP_DIR}/docs/user-guide`, `${SOURCE_DIR}/docs/user-guide`);
-cp('-R', `${TMP_DIR}/docs/about`, `${SOURCE_DIR}`);
-cp(`${TMP_DIR}/CHANGELOG.md`, `${SOURCE_DIR}/about`);
+cp('-R', `${PACKAGES_TMP_DIR}/sonarwhal/docs/contributor-guide`, `${SOURCE_DIR}/docs/contributor-guide`);
+cp('-R', `${PACKAGES_TMP_DIR}/sonarwhal/docs/user-guide`, `${SOURCE_DIR}/docs/user-guide`);
+cp('-R', `${PACKAGES_TMP_DIR}/sonarwhal/docs/about`, `${SOURCE_DIR}`);
+cp(`${PACKAGES_TMP_DIR}/sonarwhal/CHANGELOG.md`, `${SOURCE_DIR}/about`);
+
+const rules = ls('-R', `${PACKAGES_TMP_DIR}/rule-*/README.md`);
+
+rules.forEach((rulePath) => {
+    const ruleName = rulePath.split('/').reverse()[1];
+    const destRulePath = `${SOURCE_DIR}/docs/user-guide/rules/${ruleName}.md`;
+
+    mv(rulePath, destRulePath);
+});
 
 rm('-rf', TMP_DIR);

package.json

@@ -79,7 +79,7 @@
     "lint:browser": "eslint -c .eslintrc --env browser src/sonarwhal-theme/source/**/*.js",
     "lint:js": "npm run lint:node && npm run lint:browser",
     "lint:md": "markdownlint README.md ./src/hexo/source",
-    "lint:node": "eslint -c .eslintrc --env node **/*.js --ignore-pattern src/sonarwhal-theme/source/**/*.js --ignore-pattern dist/**/*.js",
+    "lint:node": "eslint -c .eslintrc --env node **/*.js --ignore-pattern src/sonarwhal-theme/source/**/*.js --ignore-pattern src/sonarwhal-theme-optimized/**/*.js --ignore-pattern dist/**/*.js",
     "lint:styles": "stylelint src/hexo/themes/sonarwhal/source/**/*.css --config .stylelintrc",
     "start": "npm run build -- watch",
     "watch": "gulp watch",

src/sonarwhal-theme/scripts/link-filter.js

@@ -6,6 +6,8 @@ hexo.extend.filter.register('before_post_render', (data) => {
     // - doesn't start with `http`, `https` or `ftp`
     // - endes with `.md`
     const mdUrlRegex = /\((?!(http|https|ftp):)([^(|)]+\.md)[^(|)]*\)/g;
+    const ruleUrlRegex = /(?:..\/)*(rule-.*)\/README/i;
+    const isRulePage = data.source.includes('rules');
     let match;
 
     while ((match = mdUrlRegex.exec(data.content)) !== null) {
@@ -22,6 +24,10 @@ hexo.extend.filter.register('before_post_render', (data) => {
             matchHtmlUrl = matchHtmlUrl.replace(/\((.*?)\)/g, '(../$1)');
         }
 
-        data.content = data.content.replace(matchMdUrl, matchHtmlUrl);
+        // ../../../../rule-axe/README/ => rule-axe
+        const matchRuleUrl = matchHtmlUrl.match(ruleUrlRegex);
+        const newUrl = isRulePage && matchRuleUrl ? `(${matchRuleUrl.pop()})` : matchHtmlUrl;
+
+        data.content = data.content.replace(matchMdUrl, newUrl);
     }
 });