Merge pull request #587 from weseek/support/refactor-directory-structure

Support/refactor directory structure

.eslintignore

@@ -2,6 +2,6 @@
 /.vscode/**
 /node_modules/**
 /public/**
-/resource/js/legacy/thirdparty-js/**
+/src/client/js/legacy/thirdparty-js/**
 /test/**
 /tmp/**

CHANGES.md

@@ -3,7 +3,7 @@ CHANGES
 
 ## 3.2.1-RC
 
-* 
+* Support: Refactor directory structure
 
 ## 3.2.0
 

bin/generate-plugin-definitions-source.js

@@ -3,17 +3,19 @@
  *
  * @author Yuki Takei <yuki@weseek.co.jp>
  */
+require('module-alias/register');
+
 const fs = require('graceful-fs');
 const normalize = require('normalize-path');
 const swig = require('swig-templates');
-const helpers = require('../config/helpers');
+
+const helpers = require('@commons/util/helpers');
+const PluginUtils = require('../src/server/plugins/plugin-utils');
+const pluginUtils = new PluginUtils();
 
 const TEMPLATE = helpers.root('bin/templates/plugin-definitions.js.swig');
 const OUT = helpers.root('tmp/plugins/plugin-definitions.js');
 
-const PluginUtils = require('../lib/plugins/plugin-utils');
-const pluginUtils = new PluginUtils();
-
 
 // list plugin names
 let pluginNames = pluginUtils.listPluginNames(helpers.root());
@@ -45,8 +47,8 @@ const definitions = pluginNames
     return definition;
   });
 
-var compiledTemplate = swig.compileFile(TEMPLATE);
-var code = compiledTemplate({definitions});
+const compiledTemplate = swig.compileFile(TEMPLATE);
+const code = compiledTemplate({definitions});
 
 // write
 fs.writeFileSync(OUT, code);

bin/shrink-emojione-strategy.js

@@ -3,13 +3,15 @@
  *
  * @author Yuki Takei <yuki@weseek.co.jp>
  */
+require('module-alias/register');
+
 const fs = require('graceful-fs');
-const helpers = require('../config/helpers');
 
-const OUT = helpers.root('tmp/emoji_strategy_shrinked.json');
+const helpers = require('@commons/util/helpers');
 
 const emojiStrategy = require('emojione/emoji_strategy.json');
 const markdownItEmojiFull = require('markdown-it-emoji/lib/data/full.json');
+const OUT = helpers.root('tmp/emoji_strategy_shrinked.json');
 
 let shrinkedMap = {};
 for (let unicode in emojiStrategy) {

config/webpack.common.js

@@ -1,9 +1,8 @@
 /**
  * @author: Yuki Takei <yuki@weseek.co.jp>
  */
-
 const webpack = require('webpack');
-const helpers = require('./helpers');
+const helpers = require('../src/lib/util/helpers');
 
 /*
  * Webpack Plugins
@@ -20,26 +19,26 @@ module.exports = (options) => {
   return {
     mode: options.mode,
     entry: Object.assign({
-      'js/app':                   './resource/js/app',
-      'js/legacy':                './resource/js/legacy/crowi',
-      'js/legacy-admin':          './resource/js/legacy/crowi-admin',
-      'js/legacy-presentation':   './resource/js/legacy/crowi-presentation',
-      'js/plugin':                './resource/js/plugin',
-      'js/ie11-polyfill':         './resource/js/ie11-polyfill',
-      'js/hackmd-agent':          './resource/js/hackmd-agent',
-      'js/hackmd-styles':         './resource/js/hackmd-styles',
+      'js/app':                       './src/client/js/app',
+      'js/legacy':                    './src/client/js/legacy/crowi',
+      'js/legacy-admin':              './src/client/js/legacy/crowi-admin',
+      'js/legacy-presentation':       './src/client/js/legacy/crowi-presentation',
+      'js/plugin':                    './src/client/js/plugin',
+      'js/ie11-polyfill':             './src/client/js/ie11-polyfill',
+      'js/hackmd-agent':              './src/client/js/hackmd-agent',
+      'js/hackmd-styles':             './src/client/js/hackmd-styles',
       // styles
-      'styles/style':                './resource/styles/scss/style.scss',
-      'styles/style-presentation':   './resource/styles/scss/style-presentation.scss',
+      'styles/style':                 './src/client/styles/scss/style.scss',
+      'styles/style-presentation':    './src/client/styles/scss/style-presentation.scss',
       // themes
-      'styles/theme-default':        './resource/styles/scss/theme/default.scss',
-      'styles/theme-default-dark':   './resource/styles/scss/theme/default-dark.scss',
-      'styles/theme-nature':         './resource/styles/scss/theme/nature.scss',
-      'styles/theme-mono-blue':      './resource/styles/scss/theme/mono-blue.scss',
-      'styles/theme-future':         './resource/styles/scss/theme/future.scss',
-      'styles/theme-blue-night':     './resource/styles/scss/theme/blue-night.scss',
+      'styles/theme-default':         './src/client/styles/scss/theme/default.scss',
+      'styles/theme-default-dark':    './src/client/styles/scss/theme/default-dark.scss',
+      'styles/theme-nature':          './src/client/styles/scss/theme/nature.scss',
+      'styles/theme-mono-blue':       './src/client/styles/scss/theme/mono-blue.scss',
+      'styles/theme-future':          './src/client/styles/scss/theme/future.scss',
+      'styles/theme-blue-night':      './src/client/styles/scss/theme/blue-night.scss',
       // styles for external services
-      'styles/style-hackmd':         './resource/styles/hackmd/style.scss',
+      'styles/style-hackmd':          './src/client/styles/hackmd/style.scss',
     }, options.entry || {}),  // Merge with env dependent settings
     output: Object.assign({
       path: helpers.root('public'),
@@ -55,11 +54,13 @@ module.exports = (options) => {
     },
     resolve: {
       extensions: ['.js', '.jsx', '.json'],
-      modules: [helpers.root('src'), helpers.root('node_modules')],
+      modules: [helpers.root('node_modules')],
       alias: {
         '@root': helpers.root('/'),
-        '@alias/logger': helpers.root('lib/service/logger'),
-        '@alias/locales': helpers.root('lib/locales'),
+        '@commons': helpers.root('src/lib'),
+        '@tmp': helpers.root('tmp'),
+        '@alias/logger': helpers.root('src/lib/service/logger'),
+        '@alias/locales': helpers.root('resource/locales'),
         // replace bunyan
         'bunyan': 'browser-bunyan',
       }
@@ -93,12 +94,12 @@ module.exports = (options) => {
         {
           test: /\.css$/,
           use: ['style-loader', 'css-loader'],
-          exclude: [helpers.root('resource/styles')]
+          exclude: [helpers.root('src/client/styles')]
         },
         {
           test: /\.scss$/,
           use: ['style-loader', 'css-loader', 'sass-loader'],
-          exclude: [helpers.root('resource/styles')]
+          exclude: [helpers.root('src/client/styles')]
         },
         /*
          * File loader for supporting images, for example, in CSS files.
@@ -144,7 +145,7 @@ module.exports = (options) => {
       splitChunks: {
         cacheGroups: {
           commons: {
-            test: /resource/,
+            test: /src/,
             chunks: 'initial',
             name: 'js/commons',
             minChunks: 2,

config/webpack.dev.js

@@ -4,7 +4,7 @@
 
 const path = require('path');
 const webpack = require('webpack');
-const helpers = require('./helpers');
+const helpers = require('../src/lib/util/helpers');
 
 /*
  * Webpack Plugins
@@ -21,7 +21,7 @@ module.exports = require('./webpack.common')({
   mode: 'development',
   devtool: 'cheap-module-eval-source-map',
   entry: {
-    'js/dev': './resource/js/dev',
+    'js/dev': './src/client/js/dev',
   },
   resolve: {
     // TODO merge in webpack.common.js
@@ -36,7 +36,7 @@ module.exports = require('./webpack.common')({
           { loader: 'css-loader', options: { sourceMap: true } },
           { loader: 'sass-loader', options: { sourceMap: true } },
         ],
-        include: [helpers.root('resource/styles/scss')]
+        include: [helpers.root('src/client/styles/scss')]
       },
       { // Dump CSS for HackMD
         test: /\.scss$/,
@@ -46,7 +46,7 @@ module.exports = require('./webpack.common')({
             'sass-loader'
           ]
         }),
-        include: [helpers.root('resource/styles/hackmd')]
+        include: [helpers.root('src/client/styles/hackmd')]
       },
     ],
   },

config/webpack.dll.js

@@ -2,7 +2,7 @@
  * @author: Yuki Takei <yuki@weseek.co.jp>
  */
 const webpack = require('webpack');
-const helpers = require('./helpers');
+const helpers = require('../src/lib/util/helpers');
 
 
 module.exports = {

config/webpack.prod.js

@@ -1,8 +1,7 @@
 /**
  * @author: Yuki Takei <yuki@weseek.co.jp>
  */
-
-const helpers = require('./helpers');
+const helpers = require('../src/lib/util/helpers');
 
 /**
  * Webpack Plugins
@@ -40,7 +39,7 @@ module.exports = require('./webpack.common')({
             'sass-loader'
           ]
         }),
-        include: [helpers.root('resource/styles/scss'), helpers.root('resource/styles/hackmd')]
+        include: [helpers.root('src/client/styles/scss'), helpers.root('src/client/styles/hackmd')]
       }
     ]
   },

lib/util/fileUploader.js

@@ -1,13 +0,0 @@
-/**
- * fileUploader
- */
-
-module.exports = function(crowi) {
-  'use strict';
-
-  var debug = require('debug')('growi:lib:fileUploader')
-    , method = crowi.env.FILE_UPLOAD || 'aws'
-    , lib = '../../local_modules/crowi-fileupload-' + method;
-
-  return require(lib)(crowi);
-};

package.json

@@ -42,13 +42,13 @@
     "prebuild:dev:app": "env-cmd config/env.dev.js npm run plugin:def",
     "prebuild:prod": "npm run plugin:def",
     "prestart": "npm run build:prod",
-    "server:debug": "env-cmd config/env.dev.js node-dev --inspect app.js",
-    "server:dev": "env-cmd config/env.dev.js node-dev --respawn app.js",
+    "server:debug": "env-cmd config/env.dev.js node-dev --inspect src/server/app.js",
+    "server:dev": "env-cmd config/env.dev.js node-dev --respawn src/server/app.js",
     "server:prod:ci": "npm run server:prod -- --ci",
-    "server:prod": "env-cmd config/env.prod.js node app.js",
+    "server:prod": "env-cmd config/env.prod.js node src/server/app.js",
     "server": "npm run server:dev",
     "start": "npm run server:prod",
-    "test": "mocha --timeout 10000 -r test/bootstrap.js test/**/*.js",
+    "test": "mocha --timeout 10000 -r src/test/bootstrap.js src/test/**/*.js",
     "version": "node -p \"require('./package.json').version\"",
     "webpack": "webpack"
   },
@@ -200,8 +200,10 @@
   },
   "_moduleAliases": {
     "@root": ".",
-    "@alias/logger": "lib/service/logger",
-    "debug": "lib/service/logger/alias-for-debug"
+    "@commons": "src/lib",
+    "@server": "src/server",
+    "@alias/logger": "src/lib/service/logger",
+    "debug": "src/lib/service/logger/alias-for-debug"
   },
   "engines": {
     "node": ">=8.11.1 <9",
@@ -210,7 +212,7 @@
   },
   "config": {
     "blanket": {
-      "pattern": "./lib/**/*.js"
+      "pattern": "./src/lib/**/*.js"
     }
   }
 }

resource/js/app.js → src/client/js/app.js

@@ -8,7 +8,7 @@ import io from 'socket.io-client';
 import i18nFactory from './i18n';
 
 import loggerFactory from '@alias/logger';
-import Xss from '../../lib/util/xss';
+import Xss from '@commons/service/xss';
 
 import Crowi from './util/Crowi';
 // import CrowiRenderer from './util/CrowiRenderer';

resource/js/components/PageEditor/CodeMirrorEditor.js → src/client/js/components/PageEditor/CodeMirrorEditor.js

@@ -3,7 +3,7 @@ import PropTypes from 'prop-types';
 
 import Modal from 'react-bootstrap/es/Modal';
 
-import AbstractEditor from './AbstractEditor';
+import InterceptorManager from '@commons/service/interceptor-manager';
 
 import urljoin from 'url-join';
 const loadScript = require('simple-load-script');
@@ -41,11 +41,11 @@ require('codemirror/addon/display/placeholder');
 require('codemirror/mode/gfm/gfm');
 require('../../util/codemirror/autorefresh.ext');
 
+import AbstractEditor from './AbstractEditor';
+
 import pasteHelper from './PasteHelper';
 import EmojiAutoCompleteHelper from './EmojiAutoCompleteHelper';
 
-import InterceptorManager from '../../../../lib/util/interceptor-manager';
-
 import PreventMarkdownListInterceptor from './PreventMarkdownListInterceptor';
 import MarkdownTableInterceptor from './MarkdownTableInterceptor';
 import mtu from './MarkdownTableUtil';

resource/js/components/PageEditor/TextAreaEditor.js → src/client/js/components/PageEditor/TextAreaEditor.js

@@ -3,13 +3,13 @@ import React from 'react';
 
 import FormControl from 'react-bootstrap/es/FormControl';
 
+import InterceptorManager from '@commons/service/interceptor-manager';
+
 import AbstractEditor from './AbstractEditor';
 
 import pasteHelper from './PasteHelper';
 import mlu from './MarkdownListUtil';
 
-import InterceptorManager from '../../../../lib/util/interceptor-manager';
-
 import PreventMarkdownListInterceptor from './PreventMarkdownListInterceptor';
 
 export default class TextAreaEditor extends AbstractEditor {

resource/js/components/PageList/PageListMeta.js → src/client/js/components/PageList/PageListMeta.js

@@ -1,5 +1,6 @@
 import React from 'react';
 import PropTypes from 'prop-types';
+import templateChecker from '@commons/util/template-checker';
 
 export default class PageListMeta extends React.Component {
 
@@ -14,7 +15,6 @@ export default class PageListMeta extends React.Component {
   render() {
     // TODO isPortal()
     const page = this.props.page;
-    const templateChecker = require('../../../../lib/util/templateChecker');
 
     // portal check
     let PortalLabel;

resource/js/hackmd-agent.js → src/client/js/hackmd-agent.js

@@ -2,7 +2,7 @@
  * GROWI agent for HackMD
  *
  * This file will be transpiled as a single JS
- *  and should be load from HackMD head via 'lib/routes/hackmd.js' route
+ *  and should be load from HackMD head via 'routes/hackmd.js' route
  *
  * USAGE:
  *  <script src="${hostname of GROWI}/_hackmd/load-agent"></script>

resource/js/hackmd-styles.js → src/client/js/hackmd-styles.js

@@ -2,7 +2,7 @@
  * GROWI styles loader for HackMD
  *
  * This file will be transpiled as a single JS
- *  and should be load from HackMD head via 'lib/routes/hackmd.js' route
+ *  and should be load from HackMD head via 'routes/hackmd.js' route
  *
  * USAGE:
  *  <script src="${hostname of GROWI}/_hackmd/load-styles"></script>