├── util ├── index.ts ├── showTable.ts └── store │ ├── index.ts │ └── store.ts ├── lib ├── template │ ├── vue2app │ │ ├── static │ │ │ └── .gitkeep │ │ ├── .eslintignore │ │ ├── config │ │ │ ├── prod.env.js │ │ │ ├── dev.env.js │ │ │ └── index.js │ │ ├── build │ │ │ ├── logo.png │ │ │ ├── vue-loader.conf.js │ │ │ ├── build.js │ │ │ ├── check-versions.js │ │ │ ├── webpack.base.conf.js │ │ │ ├── utils.js │ │ │ ├── webpack.dev.conf.js │ │ │ └── webpack.prod.conf.js │ │ ├── src │ │ │ ├── assets │ │ │ │ └── logo.png │ │ │ ├── router │ │ │ │ └── index.js │ │ │ ├── main.js │ │ │ ├── App.vue │ │ │ └── components │ │ │ │ └── HelloWorld.vue │ │ ├── .editorconfig │ │ ├── .gitignore │ │ ├── .babelrc │ │ ├── .postcssrc.js │ │ ├── index.html │ │ ├── README.md │ │ ├── .eslintrc.js │ │ └── package.json │ ├── springboot │ │ ├── src │ │ │ ├── main │ │ │ │ ├── resources │ │ │ │ │ └── application.properties │ │ │ │ └── java │ │ │ │ │ └── com │ │ │ │ │ └── elesheep │ │ │ │ │ └── demo │ │ │ │ │ └── DemoApplication.java │ │ │ └── test │ │ │ │ └── java │ │ │ │ └── com │ │ │ │ └── elesheep │ │ │ │ └── demo │ │ │ │ └── DemoApplicationTests.java │ │ └── pom.xml │ └── vue3app │ │ ├── babel.config.js │ │ ├── src │ │ ├── main.js │ │ ├── assets │ │ │ └── logo.png │ │ ├── App.vue │ │ └── components │ │ │ └── HelloWorld.vue │ │ ├── public │ │ ├── favicon.ico │ │ └── index.html │ │ ├── vue.config.js │ │ ├── .gitignore │ │ ├── jsconfig.json │ │ ├── README.md │ │ └── package.json └── config │ └── index.ts ├── .czrc ├── .gitignore ├── Contributor.md ├── tsconfig.json ├── commands ├── list.ts ├── switch.ts ├── delete.ts ├── create.ts ├── installer.ts └── save.ts ├── rollup.config.ts ├── LICENSE ├── README.md ├── package.json └── fdm.ts /util/index.ts: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /lib/template/vue2app/static/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.czrc: -------------------------------------------------------------------------------- 1 | { 2 | "path": "node_modules/cz-emoji-chinese" 3 | } -------------------------------------------------------------------------------- /lib/template/springboot/src/main/resources/application.properties: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /lib/template/vue2app/.eslintignore: -------------------------------------------------------------------------------- 1 | /build/ 2 | /config/ 3 | /dist/ 4 | /*.js 5 | -------------------------------------------------------------------------------- /lib/template/vue2app/config/prod.env.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | module.exports = { 3 | NODE_ENV: '"production"' 4 | } 5 | -------------------------------------------------------------------------------- /lib/template/vue2app/build/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Freedom-Explorers/fdm-cli/HEAD/lib/template/vue2app/build/logo.png -------------------------------------------------------------------------------- /lib/template/vue3app/babel.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | presets: [ 3 | '@vue/cli-plugin-babel/preset' 4 | ] 5 | } 6 | -------------------------------------------------------------------------------- /lib/template/vue3app/src/main.js: -------------------------------------------------------------------------------- 1 | import { createApp } from 'vue' 2 | import App from './App.vue' 3 | 4 | createApp(App).mount('#app') 5 | -------------------------------------------------------------------------------- /lib/template/vue2app/src/assets/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Freedom-Explorers/fdm-cli/HEAD/lib/template/vue2app/src/assets/logo.png -------------------------------------------------------------------------------- /lib/template/vue3app/public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Freedom-Explorers/fdm-cli/HEAD/lib/template/vue3app/public/favicon.ico -------------------------------------------------------------------------------- /lib/template/vue3app/src/assets/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Freedom-Explorers/fdm-cli/HEAD/lib/template/vue3app/src/assets/logo.png -------------------------------------------------------------------------------- /lib/template/vue3app/vue.config.js: -------------------------------------------------------------------------------- 1 | const { defineConfig } = require('@vue/cli-service') 2 | module.exports = defineConfig({ 3 | transpileDependencies: true 4 | }) 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | 3 | # dist files 4 | bin 5 | 6 | # map files 7 | **/*.js.map 8 | 9 | # log files 10 | .log* 11 | 12 | # Editor files 13 | .idea 14 | .vscode -------------------------------------------------------------------------------- /lib/template/vue2app/config/dev.env.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | const merge = require('webpack-merge') 3 | const prodEnv = require('./prod.env') 4 | 5 | module.exports = merge(prodEnv, { 6 | NODE_ENV: '"development"' 7 | }) 8 | -------------------------------------------------------------------------------- /lib/template/vue2app/.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | charset = utf-8 5 | indent_style = space 6 | indent_size = 2 7 | end_of_line = lf 8 | insert_final_newline = true 9 | trim_trailing_whitespace = true 10 | -------------------------------------------------------------------------------- /lib/template/vue2app/.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | node_modules/ 3 | /dist/ 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Editor directories and files 9 | .idea 10 | .vscode 11 | *.suo 12 | *.ntvs* 13 | *.njsproj 14 | *.sln 15 | -------------------------------------------------------------------------------- /lib/template/vue2app/.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "presets": [ 3 | ["env", { 4 | "modules": false, 5 | "targets": { 6 | "browsers": ["> 1%", "last 2 versions", "not ie <= 8"] 7 | } 8 | }], 9 | "stage-2" 10 | ], 11 | "plugins": ["transform-vue-jsx", "transform-runtime"] 12 | } 13 | -------------------------------------------------------------------------------- /lib/config/index.ts: -------------------------------------------------------------------------------- 1 | import { resolve, dirname } from 'path' 2 | import { fileURLToPath } from 'url' 3 | 4 | const __filenameNew = fileURLToPath(import.meta.url) 5 | const __dirnameNew = dirname(dirname(__filenameNew)) 6 | 7 | export const CWD = process.cwd() 8 | export const TEMPLATE = resolve(__dirnameNew, 'template') 9 | -------------------------------------------------------------------------------- /lib/template/vue2app/.postcssrc.js: -------------------------------------------------------------------------------- 1 | // https://github.com/michael-ciniawsky/postcss-load-config 2 | 3 | module.exports = { 4 | "plugins": { 5 | "postcss-import": {}, 6 | "postcss-url": {}, 7 | // to edit target browsers: use "browserslist" field in package.json 8 | "autoprefixer": {} 9 | } 10 | } 11 | -------------------------------------------------------------------------------- /lib/template/springboot/src/test/java/com/elesheep/demo/DemoApplicationTests.java: -------------------------------------------------------------------------------- 1 | package com.elesheep.demo; 2 | 3 | import org.junit.jupiter.api.Test; 4 | import org.springframework.boot.test.context.SpringBootTest; 5 | 6 | @SpringBootTest 7 | class DemoApplicationTests { 8 | 9 | @Test 10 | void contextLoads() { 11 | } 12 | 13 | } 14 | -------------------------------------------------------------------------------- /lib/template/vue2app/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | vue2app 7 | 8 | 9 |
10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /lib/template/vue2app/src/router/index.js: -------------------------------------------------------------------------------- 1 | import Vue from 'vue' 2 | import Router from 'vue-router' 3 | import HelloWorld from '@/components/HelloWorld' 4 | 5 | Vue.use(Router) 6 | 7 | export default new Router({ 8 | routes: [ 9 | { 10 | path: '/', 11 | name: 'HelloWorld', 12 | component: HelloWorld 13 | } 14 | ] 15 | }) 16 | -------------------------------------------------------------------------------- /lib/template/vue3app/.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | node_modules 3 | /dist 4 | 5 | 6 | # local env files 7 | .env.local 8 | .env.*.local 9 | 10 | # Log files 11 | npm-debug.log* 12 | yarn-debug.log* 13 | yarn-error.log* 14 | pnpm-debug.log* 15 | 16 | # Editor directories and files 17 | .idea 18 | .vscode 19 | *.suo 20 | *.ntvs* 21 | *.njsproj 22 | *.sln 23 | *.sw? 24 | -------------------------------------------------------------------------------- /lib/template/vue3app/jsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "es5", 4 | "module": "esnext", 5 | "baseUrl": "./", 6 | "moduleResolution": "node", 7 | "paths": { 8 | "@/*": [ 9 | "src/*" 10 | ] 11 | }, 12 | "lib": [ 13 | "esnext", 14 | "dom", 15 | "dom.iterable", 16 | "scripthost" 17 | ] 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /lib/template/springboot/src/main/java/com/elesheep/demo/DemoApplication.java: -------------------------------------------------------------------------------- 1 | package com.elesheep.demo; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | 6 | @SpringBootApplication 7 | public class DemoApplication { 8 | 9 | public static void main(String[] args) { 10 | SpringApplication.run(DemoApplication.class, args); 11 | } 12 | 13 | } 14 | -------------------------------------------------------------------------------- /lib/template/vue2app/src/main.js: -------------------------------------------------------------------------------- 1 | // The Vue build version to load with the `import` command 2 | // (runtime-only or standalone) has been set in webpack.base.conf with an alias. 3 | import Vue from 'vue' 4 | import App from './App' 5 | import router from './router' 6 | 7 | Vue.config.productionTip = false 8 | 9 | /* eslint-disable no-new */ 10 | new Vue({ 11 | el: '#app', 12 | router, 13 | components: { App }, 14 | template: '' 15 | }) 16 | -------------------------------------------------------------------------------- /lib/template/vue3app/README.md: -------------------------------------------------------------------------------- 1 | # vue3app 2 | 3 | ## Project setup 4 | ``` 5 | npm install 6 | ``` 7 | 8 | ### Compiles and hot-reloads for development 9 | ``` 10 | npm run serve 11 | ``` 12 | 13 | ### Compiles and minifies for production 14 | ``` 15 | npm run build 16 | ``` 17 | 18 | ### Lints and fixes files 19 | ``` 20 | npm run lint 21 | ``` 22 | 23 | ### Customize configuration 24 | See [Configuration Reference](https://cli.vuejs.org/config/). 25 | -------------------------------------------------------------------------------- /lib/template/vue2app/src/App.vue: -------------------------------------------------------------------------------- 1 | 7 | 8 | 13 | 14 | 24 | -------------------------------------------------------------------------------- /Contributor.md: -------------------------------------------------------------------------------- 1 | ## 贡献指南 2 | 3 | ### 开发准备 4 | 5 | 1. **`Fork`** 本项目 6 | 7 | 2. **`clone`** 本项目至本地 8 | 9 | 3. 改动较大时，请根据自己本次开发，**新建项目分支**，并以开发内容作为分支名 10 | 11 | 4. 在项目目录下执行 **`npm install`** 12 | 13 | ### 调试准备 14 | 15 | 在本地完成修改后，在调试时需要执行以下命令： 16 | 17 | - **`npm run build`** ( 此时可查看 /bin 下是否生成文件，完成打包 ) 18 | 19 | - **`npm link`** 20 | 21 | ### 提交准备 22 | 23 | 请将代码提交到 **`dev`** 分支。 24 | 25 | 请运行 `npm run commit` 进行 `commit` 操作或遵循 [Angular 提交信息规范](https://zj-git-guide.readthedocs.io/zh_CN/latest/message/Angular提交信息规范) 26 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "module": "ESNext", 4 | "esModuleInterop": true, 5 | "allowJs": false, 6 | "allowSyntheticDefaultImports": true, 7 | "target": "ESNext", 8 | "noImplicitAny": true, 9 | "moduleResolution": "node", 10 | "resolveJsonModule": true, 11 | "outDir": "./bin", 12 | "baseUrl": ".", 13 | "paths": { 14 | "@/*": ["./*"], 15 | "@commands/*": ["commands/*"], 16 | "@lib/*": ["lib/*"], 17 | "@util/*": ["util/*"] 18 | } 19 | } 20 | // "exclude": ["node_modules"] 21 | } 22 | -------------------------------------------------------------------------------- /lib/template/vue2app/README.md: -------------------------------------------------------------------------------- 1 | # vue2app 2 | 3 | > A Vue.js project 4 | 5 | ## Build Setup 6 | 7 | ``` bash 8 | # install dependencies 9 | npm install 10 | 11 | # serve with hot reload at localhost:8080 12 | npm run dev 13 | 14 | # build for production with minification 15 | npm run build 16 | 17 | # build for production and view the bundle analyzer report 18 | npm run build --report 19 | ``` 20 | 21 | For a detailed explanation on how things work, check out the [guide](http://vuejs-templates.github.io/webpack/) and [docs for vue-loader](http://vuejs.github.io/vue-loader). 22 | -------------------------------------------------------------------------------- /commands/list.ts: -------------------------------------------------------------------------------- 1 | import ora from 'ora' 2 | import logSymbols from 'log-symbols' 3 | import { showTable } from '@util/showTable' 4 | import { get, Template } from '@util/store' 5 | 6 | const spinner = ora('正在为你拼命加载...\n').start() 7 | const templateList: Template[] = get('templateList') 8 | const templateNum = templateList.length 9 | 10 | try { 11 | if (templateNum === 0) { 12 | spinner.fail('模板库中似乎还没有模板，快新建一个吧') 13 | } else { 14 | spinner.succeed('模板库加载成功，请查看结果') 15 | // console.log(files) 16 | showTable(templateList) 17 | } 18 | } catch (error) { 19 | console.error(logSymbols.error, error) 20 | } 21 | -------------------------------------------------------------------------------- /lib/template/vue3app/src/App.vue: -------------------------------------------------------------------------------- 1 | 5 | 6 | 16 | 17 | 27 | -------------------------------------------------------------------------------- /lib/template/vue2app/build/vue-loader.conf.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | const utils = require('./utils') 3 | const config = require('../config') 4 | const isProduction = process.env.NODE_ENV === 'production' 5 | const sourceMapEnabled = isProduction 6 | ? config.build.productionSourceMap 7 | : config.dev.cssSourceMap 8 | 9 | module.exports = { 10 | loaders: utils.cssLoaders({ 11 | sourceMap: sourceMapEnabled, 12 | extract: isProduction 13 | }), 14 | cssSourceMap: sourceMapEnabled, 15 | cacheBusting: config.dev.cacheBusting, 16 | transformToRequire: { 17 | video: ['src', 'poster'], 18 | source: 'src', 19 | img: 'src', 20 | image: 'xlink:href' 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /util/showTable.ts: -------------------------------------------------------------------------------- 1 | import Table from 'cli-table3' 2 | import logSymbols from 'log-symbols' 3 | import { Template } from '@util/store' 4 | 5 | const table = new Table({ 6 | head: ['模板名', '模板信息'], 7 | style: { 8 | head: ['green'] 9 | } 10 | }) 11 | 12 | export function showTable(tempList: Template[]) { 13 | const list = tempList 14 | if (list.length > 0) { 15 | list.forEach((tem) => { 16 | table.push([tem.name, tem.description]) 17 | if (table.length === list.length) { 18 | console.log(table.toString()) 19 | process.exit() 20 | } 21 | }) 22 | } else { 23 | console.log(logSymbols.info, '模板库中暂无模板，请等待官方添加哦~') 24 | process.exit() 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /lib/template/vue3app/public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | <%= htmlWebpackPlugin.options.title %> 9 | 10 | 11 | 14 |
15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /util/store/index.ts: -------------------------------------------------------------------------------- 1 | import config from '@util/store/store' 2 | export { Config, Template } from '@util/store/store' 3 | 4 | export const set = (key: string, value: any) => config.set(key, value) 5 | 6 | export const get = (key: string) => config.get(key) 7 | 8 | export const del = (key: string) => config.delete(key) 9 | 10 | export const use = (key: string, value: any) => { 11 | set(key, value) 12 | return [() => get(key), (value: any) => set(key, value)] 13 | } 14 | 15 | // TODO: reset 16 | // export const reset = () => ( 17 | // // config.clear(), 18 | // // Object.keys(defaultConfig).forEach((key) => 19 | // // set(key, defaultConfig[key as keyof config]) 20 | // // ) 21 | // ) 22 | 23 | export const getPath = () => config.path 24 | -------------------------------------------------------------------------------- /commands/switch.ts: -------------------------------------------------------------------------------- 1 | import ora from 'ora' 2 | import logSymbols from 'log-symbols' 3 | import { set } from '@util/store' 4 | import { execSync } from 'child_process' 5 | const spinner = ora('切换中...\n').start() 6 | export function switchPackageManager(packageManager: String) { 7 | if (!packageManager) { 8 | // 默认包管理器为npm 9 | set('packageManager', 'npm') 10 | spinner.succeed(`当前为npm!`) 11 | } else { 12 | if (packageManagerExists(packageManager)) { 13 | spinner.succeed(`切换成功，已切换为${packageManager}!`) 14 | } 15 | } 16 | } 17 | 18 | function packageManagerExists(packageManager: String) { 19 | try { 20 | // 尝试执行命令，如果命令不存在会抛出异常 21 | execSync(`${packageManager} -v`, { stdio: 'ignore' }) 22 | return true 23 | } catch (error) { 24 | spinner.fail('切换失败') 25 | console.error(logSymbols.error, error) 26 | return false 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /lib/template/vue2app/.eslintrc.js: -------------------------------------------------------------------------------- 1 | // https://eslint.org/docs/user-guide/configuring 2 | 3 | module.exports = { 4 | root: true, 5 | parserOptions: { 6 | parser: 'babel-eslint' 7 | }, 8 | env: { 9 | browser: true, 10 | }, 11 | extends: [ 12 | // https://github.com/vuejs/eslint-plugin-vue#priority-a-essential-error-prevention 13 | // consider switching to `plugin:vue/strongly-recommended` or `plugin:vue/recommended` for stricter rules. 14 | 'plugin:vue/essential', 15 | // https://github.com/standard/standard/blob/master/docs/RULES-en.md 16 | 'standard' 17 | ], 18 | // required to lint *.vue files 19 | plugins: [ 20 | 'vue' 21 | ], 22 | // add your custom rules here 23 | rules: { 24 | // allow async-await 25 | 'generator-star-spacing': 'off', 26 | // allow debugger during development 27 | 'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off' 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /rollup.config.ts: -------------------------------------------------------------------------------- 1 | import path from 'path' 2 | import alies from '@rollup/plugin-alias' 3 | import { cleandir } from 'rollup-plugin-cleandir' 4 | import copy from 'rollup-plugin-copy' 5 | import { externals } from 'rollup-plugin-node-externals' 6 | import json from '@rollup/plugin-json' 7 | import typescript from '@rollup/plugin-typescript' 8 | 9 | const outDir = path.dirname('bin/fdm.js') 10 | 11 | export default { 12 | input: 'fdm.ts', 13 | output: [ 14 | { 15 | dir: outDir, 16 | format: 'esm', 17 | preserveModules: true, 18 | banner: '#!/usr/bin/env node' 19 | } 20 | ], 21 | plugins: [ 22 | alies({ 23 | entries: [{ find: '@', replacement: '.' }] 24 | }), 25 | cleandir(outDir), 26 | copy({ 27 | targets: [{ src: 'lib/template', dest: 'bin/lib' }] 28 | }), 29 | externals(), 30 | json(), 31 | typescript({ 32 | tsconfig: 'tsconfig.json' 33 | }) 34 | ] 35 | } 36 | -------------------------------------------------------------------------------- /commands/delete.ts: -------------------------------------------------------------------------------- 1 | import logSymbols from 'log-symbols' 2 | import { get, set, Template } from '@util/store' 3 | import { remove } from 'fs-extra' 4 | import { TEMPLATE } from '@lib/config' 5 | import { resolve } from 'path' 6 | 7 | let templateList: Template[] = get('templateList') 8 | const templateListNames = templateList.map((item) => item.name) 9 | 10 | export function deleteTemplate(templateName:string) { 11 | if (!templateListNames.includes(templateName)) { 12 | console.error(logSymbols.error, '输入的模板名称不存在！') 13 | } 14 | 15 | try { 16 | // 删除存储中的对象信息 17 | delTelByName(templateName) 18 | // 删除文件存放目录的文件信息 19 | remove( resolve(TEMPLATE, templateName)) 20 | console.log(logSymbols.success, '模板删除成功！') 21 | } catch (error) { 22 | console.error(logSymbols.error, error) 23 | } 24 | } 25 | 26 | const delTelByName = (templateName: string) => { 27 | templateList = templateList.filter((item) => { 28 | return item.name !== templateName 29 | }) 30 | set('templateList',templateList) 31 | } -------------------------------------------------------------------------------- /lib/template/vue3app/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "vue3app", 3 | "version": "0.1.0", 4 | "private": true, 5 | "scripts": { 6 | "serve": "vue-cli-service serve", 7 | "build": "vue-cli-service build", 8 | "lint": "vue-cli-service lint" 9 | }, 10 | "dependencies": { 11 | "core-js": "^3.8.3", 12 | "vue": "^3.2.13" 13 | }, 14 | "devDependencies": { 15 | "@babel/core": "^7.12.16", 16 | "@babel/eslint-parser": "^7.12.16", 17 | "@vue/cli-plugin-babel": "~5.0.0", 18 | "@vue/cli-plugin-eslint": "~5.0.0", 19 | "@vue/cli-service": "~5.0.0", 20 | "eslint": "^7.32.0", 21 | "eslint-plugin-vue": "^8.0.3" 22 | }, 23 | "eslintConfig": { 24 | "root": true, 25 | "env": { 26 | "node": true 27 | }, 28 | "extends": [ 29 | "plugin:vue/vue3-essential", 30 | "eslint:recommended" 31 | ], 32 | "parserOptions": { 33 | "parser": "@babel/eslint-parser" 34 | }, 35 | "rules": {} 36 | }, 37 | "browserslist": [ 38 | "> 1%", 39 | "last 2 versions", 40 | "not dead", 41 | "not ie 11" 42 | ] 43 | } 44 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 Ned 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /lib/template/vue2app/build/build.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | require('./check-versions')() 3 | 4 | process.env.NODE_ENV = 'production' 5 | 6 | const ora = require('ora') 7 | const rm = require('rimraf') 8 | const path = require('path') 9 | const chalk = require('chalk') 10 | const webpack = require('webpack') 11 | const config = require('../config') 12 | const webpackConfig = require('./webpack.prod.conf') 13 | 14 | const spinner = ora('building for production...') 15 | spinner.start() 16 | 17 | rm(path.join(config.build.assetsRoot, config.build.assetsSubDirectory), err => { 18 | if (err) throw err 19 | webpack(webpackConfig, (err, stats) => { 20 | spinner.stop() 21 | if (err) throw err 22 | process.stdout.write(stats.toString({ 23 | colors: true, 24 | modules: false, 25 | children: false, // If you are using ts-loader, setting this to true will make TypeScript errors show up during build. 26 | chunks: false, 27 | chunkModules: false 28 | }) + '\n\n') 29 | 30 | if (stats.hasErrors()) { 31 | console.log(chalk.red(' Build failed with errors.\n')) 32 | process.exit(1) 33 | } 34 | 35 | console.log(chalk.cyan(' Build complete.\n')) 36 | console.log(chalk.yellow( 37 | ' Tip: built files are meant to be served over an HTTP server.\n' + 38 | ' Opening index.html over file:// won\'t work.\n' 39 | )) 40 | }) 41 | }) 42 | -------------------------------------------------------------------------------- /util/store/store.ts: -------------------------------------------------------------------------------- 1 | import Configstore from 'configstore' 2 | 3 | export interface Template { 4 | name: string 5 | description: string 6 | } 7 | 8 | export interface Config { 9 | packageManager: string 10 | templateList: Template[] 11 | } 12 | 13 | const defaultConfig: Config = { 14 | packageManager: '', 15 | templateList: [ 16 | { 17 | name: 'vue2app', 18 | description: 'vue2 app template' 19 | }, 20 | { 21 | name: 'vue3app', 22 | description: 'vue3 app template' 23 | }, 24 | { 25 | name: 'springboot', 26 | description: 'a java template' 27 | } 28 | ] 29 | } 30 | 31 | const config = new Configstore('fdm-cli', defaultConfig) 32 | 33 | const defaultTemSymbolSet = new Set( 34 | defaultConfig.templateList.map((item) => Symbol.for(JSON.stringify(item))) 35 | ) 36 | 37 | const templateList: Template[] = config.get('templateList') 38 | 39 | templateList.forEach((item: Template) => { 40 | const symbol = Symbol.for(JSON.stringify(item)) 41 | if (defaultTemSymbolSet.has(symbol)) { 42 | defaultTemSymbolSet.delete(symbol) 43 | } 44 | }) 45 | 46 | if (defaultTemSymbolSet.size) { 47 | defaultTemSymbolSet.forEach((symbol) => 48 | templateList.push(JSON.parse(Symbol.keyFor(symbol)) as Template) 49 | ) 50 | 51 | config.set( 52 | 'templateList', 53 | templateList.sort((a, b) => a.name.localeCompare(b.name)) 54 | ) 55 | } 56 | 57 | export default config 58 | -------------------------------------------------------------------------------- /lib/template/vue2app/build/check-versions.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | const chalk = require('chalk') 3 | const semver = require('semver') 4 | const packageConfig = require('../package.json') 5 | const shell = require('shelljs') 6 | 7 | function exec (cmd) { 8 | return require('child_process').execSync(cmd).toString().trim() 9 | } 10 | 11 | const versionRequirements = [ 12 | { 13 | name: 'node', 14 | currentVersion: semver.clean(process.version), 15 | versionRequirement: packageConfig.engines.node 16 | } 17 | ] 18 | 19 | if (shell.which('npm')) { 20 | versionRequirements.push({ 21 | name: 'npm', 22 | currentVersion: exec('npm --version'), 23 | versionRequirement: packageConfig.engines.npm 24 | }) 25 | } 26 | 27 | module.exports = function () { 28 | const warnings = [] 29 | 30 | for (let i = 0; i < versionRequirements.length; i++) { 31 | const mod = versionRequirements[i] 32 | 33 | if (!semver.satisfies(mod.currentVersion, mod.versionRequirement)) { 34 | warnings.push(mod.name + ': ' + 35 | chalk.red(mod.currentVersion) + ' should be ' + 36 | chalk.green(mod.versionRequirement) 37 | ) 38 | } 39 | } 40 | 41 | if (warnings.length) { 42 | console.log('') 43 | console.log(chalk.yellow('To use this template, you must update following to modules:')) 44 | console.log() 45 | 46 | for (let i = 0; i < warnings.length; i++) { 47 | const warning = warnings[i] 48 | console.log(' ' + warning) 49 | } 50 | 51 | console.log() 52 | process.exit(1) 53 | } 54 | } 55 | -------------------------------------------------------------------------------- /commands/create.ts: -------------------------------------------------------------------------------- 1 | import pkg, { copy } from 'fs-extra' 2 | import inquirer from 'inquirer' 3 | import ora from 'ora' 4 | import logSymbols from 'log-symbols' 5 | import { resolve } from 'path' 6 | import { CWD, TEMPLATE } from '@lib/config' 7 | import { get, Template } from '@util/store' 8 | const { pathExistsSync } = pkg 9 | const { prompt } = inquirer 10 | const templateList: Template[] = get('templateList') 11 | const templateNum = templateList.length 12 | const templateNames = templateList.map((tem) => { 13 | return tem.name 14 | }) 15 | 16 | export async function createProject(project: { name: string }) { 17 | if (!templateNum) { 18 | console.error( 19 | logSymbols.error, 20 | '模板库中似乎还没有模板，快通过save命令保存一个吧' 21 | ) 22 | return 23 | } 24 | const { name } = project.name 25 | ? project 26 | : await prompt([ 27 | { 28 | type: 'input', 29 | name: 'name', 30 | message: 'Your Project Name: ', 31 | default: 'new-app' 32 | } 33 | ]) 34 | const Choice = await prompt([ 35 | { 36 | type: 'list', 37 | name: 'template', 38 | message: 'Select your project: ', 39 | choices: templateNames 40 | } 41 | ]) 42 | const dir = resolve(CWD, name) 43 | 44 | if (pathExistsSync(dir)) { 45 | console.error(logSymbols.error, `${name} already exists`) 46 | return 47 | } 48 | const template = resolve(TEMPLATE, Choice.template) 49 | const spinner = ora('正在创建中...\n').start() 50 | try { 51 | await copy(template, dir) 52 | spinner.succeed('创建成功，请查看结果') 53 | } catch (error) { 54 | spinner.fail('创建失败') 55 | console.error(logSymbols.error, error) 56 | } 57 | } 58 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ☃️fdm-cli 2 | 3 |

4 | 5 | npm 6 | 7 | 8 | star 9 | 10 | 11 | license 12 | 13 | 14 | npm-stats 15 | 16 |

17 | 18 | A freedom-cli ( 一个向往自由的脚手架 ) 19 | 20 | ## 📜 目的 21 | 22 | 提高脚手架的自由度，可以灵活的搭建自己想要的初始化项目 23 | 24 | ## 🛻 安装 25 | 26 | ``` 27 | npm install fdm-cli -g 28 | ``` 29 | 30 | ## 📣 如何使用 31 | 32 | 1. `fdm create` 根据模板库创建项目 33 | 2. `fdm list` 查看模板清单 34 | 3. `fdm switch ` 切换使用的包管理器，不填则默认使用 npm 35 | 4. `fdm install ` 下载依赖 同 npm 36 | 5. `fdm uninstall ` 卸载依赖 同 npm 37 | 6. `fdm save ` 根据路径保存所选项目至模板库，下次可直接从模板库获取 38 | > `fdm save -l ` 根据路径保存路径下所有子目录（一个子目录视为一个模板） 39 | 7. `fdm delete ` 删除模板 40 | 41 | ## 🤝 参与贡献 42 | 43 | 欢迎你参与到 fdm-cli 项目的建设中来！🎉 44 | 45 | 通过参与 fdm-cli 项目，我们可以一起： 46 | 47 | 🔥 学习最新的 TypeScript 技术 48 | 49 | 🎁 学习如何设计和开发一款自己的脚手架 50 | 51 | ⭐ 磨练编程技能，学习优秀的编程实践 52 | 53 | 🎊 结识一群热爱学习、热爱开源的朋友 54 | 55 | 如果你不知道从哪儿开始，可以阅读我们的 [贡献指南](https://github.com/wangenze267/fdm-cli/blob/main/Contributor.md) 56 | 57 | ## 🌠 维护者 58 | 59 | - [Ned](https://github.com/wangenze267) 60 | - [Conard](https://github.com/Conard-Ferenc) 61 | -------------------------------------------------------------------------------- /commands/installer.ts: -------------------------------------------------------------------------------- 1 | import { get } from '@util/store' 2 | import { ExecException, exec } from 'child_process' 3 | import logSymbols from 'log-symbols' 4 | import ora from 'ora' 5 | 6 | const packageManager = get('packageManager') 7 | 8 | const installTip = `${packageManager} Installing` 9 | const installPackageTip = `Installing package:` 10 | const unInstallTip = `${packageManager} unInstalling` 11 | const unInstallPackageTip = `unInstalling package:` 12 | 13 | export function installPackage(packageName: String) { 14 | const spinner = ora( 15 | `${packageName ? installPackageTip : installTip} ${packageName}...\n` 16 | ).start() 17 | exec( 18 | `${packageManager} install ${packageName}`, 19 | (error: ExecException, stdout: string, stderr: string) => { 20 | if (error) { 21 | spinner.fail('下载失败，似乎发生了什么错误') 22 | console.error(logSymbols.error, `Error: ${error.message}`) 23 | return 24 | } 25 | spinner.succeed('下载成功') 26 | console.log(logSymbols.success, `${stdout}`) 27 | console.error(logSymbols.error, `${stderr}`) 28 | } 29 | ) 30 | } 31 | 32 | export function unInstallPackage(packageName: String) { 33 | const spinner = ora( 34 | `${packageName ? unInstallPackageTip : unInstallTip} ${packageName}...\n` 35 | ).start() 36 | exec( 37 | `npm uninstall ${packageName}`, 38 | (error: ExecException, stdout: string, stderr: string) => { 39 | if (error) { 40 | spinner.fail('删除失败，似乎发生了什么错误') 41 | console.error(logSymbols.error, `Error: ${error.message}`) 42 | return 43 | } 44 | spinner.succeed('删除成功') 45 | console.log(logSymbols.success, `${stdout}`) 46 | console.error(logSymbols.error, `${stderr}`) 47 | } 48 | ) 49 | } 50 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "fdm-cli", 3 | "version": "0.1.4", 4 | "description": "freedom-cli", 5 | "type": "module", 6 | "main": "bin/fdm.js", 7 | "module": "fdm.ts", 8 | "files": [ 9 | "bin" 10 | ], 11 | "scripts": { 12 | "test": "echo \"Error: no test specified\" && exit 1", 13 | "build": "npx rollup --config rollup.config.ts --configPlugin typescript", 14 | "commit": "git-cz" 15 | }, 16 | "bin": { 17 | "fdm": "bin/fdm.js" 18 | }, 19 | "repository": { 20 | "type": "git", 21 | "url": "git+https://github.com/wangenze267/fdm-cli.git" 22 | }, 23 | "keywords": [ 24 | "CLI" 25 | ], 26 | "author": "Ned", 27 | "license": "MIT", 28 | "bugs": { 29 | "url": "https://github.com/wangenze267/fdm-cli/issues" 30 | }, 31 | "homepage": "https://github.com/wangenze267/fdm-cli/", 32 | "dependencies": { 33 | "chalk": "^5.3.0", 34 | "cli-table3": "^0.6.3", 35 | "commander": "^11.0.0", 36 | "configstore": "^6.0.0", 37 | "download-git-repo": "^3.0.2", 38 | "fs-extra": "^11.1.1", 39 | "inquirer": "^9.2.10", 40 | "log-symbols": "^5.1.0", 41 | "ora": "^7.0.1" 42 | }, 43 | "devDependencies": { 44 | "@rollup/plugin-alias": "^5.0.0", 45 | "@rollup/plugin-json": "^6.0.0", 46 | "@rollup/plugin-typescript": "^11.1.2", 47 | "@types/cli-table": "^0.3.1", 48 | "@types/configstore": "^6.0.0", 49 | "@types/fs-extra": "^11.0.1", 50 | "@types/inquirer": "^9.0.3", 51 | "@types/node": "^20.4.10", 52 | "commitizen": "^4.3.0", 53 | "cz-emoji-chinese": "^0.3.1", 54 | "rollup": "^3.28.0", 55 | "rollup-plugin-cleandir": "^2.0.0", 56 | "rollup-plugin-copy": "^3.4.0", 57 | "rollup-plugin-node-externals": "^6.1.1", 58 | "typescript": "^5.1.6" 59 | } 60 | } 61 | -------------------------------------------------------------------------------- /commands/save.ts: -------------------------------------------------------------------------------- 1 | import { CWD, TEMPLATE } from '@lib/config' 2 | import { get, set, Template } from '@util/store' 3 | import pkg, { copy } from 'fs-extra' 4 | import inquirer from 'inquirer' 5 | import logSymbols from 'log-symbols' 6 | import { resolve } from 'path' 7 | const { readdirSync } = pkg 8 | const { prompt } = inquirer 9 | 10 | interface Option { 11 | list?: string 12 | } 13 | 14 | export async function save(option: Option, args: string[]) { 15 | if (option.list) { 16 | const nowPath = resolve(CWD, option.list) 17 | const list = readdirSync(nowPath, { withFileTypes: true }).filter( 18 | (item) => !item.name.startsWith('.') && item.isDirectory() 19 | ) 20 | for (const iterator of list) { 21 | await saveTemplate(resolve(nowPath, iterator.name), iterator.name) 22 | } 23 | } else { 24 | const [path, name = ''] = args 25 | saveTemplate(path, name) 26 | } 27 | } 28 | 29 | async function saveTemplate(path: string, name: string) { 30 | if (!path) return console.error(logSymbols.error, '请输入模板路径') 31 | const realPath = resolve(CWD, path) 32 | const fileName = realPath.split(/[\\\/]/).pop() 33 | if (!name) name = fileName ?? '' 34 | const templateList = get('templateList') 35 | const templateListSet = new Set(templateList.map((item: any) => item.name)) 36 | if (templateListSet.has(name)) { 37 | console.error(logSymbols.error, `${name}模板名已存在`) 38 | const { reName } = await prompt([ 39 | { 40 | type: 'input', 41 | name: 'reName', 42 | message: '请重新命名: ' 43 | } 44 | ]) 45 | return saveTemplate(path, reName) 46 | } else { 47 | const { description } = await prompt([ 48 | { 49 | type: 'input', 50 | name: 'description', 51 | message: '请输入描述: ', 52 | default: name 53 | } 54 | ]) 55 | const template: Template = { 56 | name, 57 | description 58 | } 59 | templateList.push(template) 60 | set('templateList', templateList) 61 | copy(realPath, resolve(TEMPLATE, name)) 62 | console.log(logSymbols.success, `${name}模板保存成功`) 63 | } 64 | } 65 | -------------------------------------------------------------------------------- /fdm.ts: -------------------------------------------------------------------------------- 1 | import { Command } from 'commander' 2 | import { version } from '@/package.json' 3 | 4 | const program = new Command() 5 | 6 | program.usage('') 7 | 8 | // 版本号命令 9 | program.version(version, '-v, --version') 10 | 11 | program 12 | .command('create') 13 | .option('-n, --name ', 'your projectName') 14 | .description('create a new project') 15 | .action(async (option) => { 16 | const { createProject } = await import('@commands/create') 17 | return createProject(option) 18 | }) 19 | 20 | program 21 | .command('list') 22 | .description('List the templateList') 23 | .action(() => { 24 | import('@commands/list') 25 | }) 26 | 27 | program 28 | .command('install [packageName]') 29 | .description('install a package') 30 | .action(async (packageName: String) => { 31 | const { installPackage } = await import('@commands/installer') 32 | return installPackage(packageName ?? '') 33 | }) 34 | 35 | program 36 | .command('uninstall [packageName]') 37 | .description('uninstall a package') 38 | .action(async (packageName: String) => { 39 | const { unInstallPackage } = await import('@commands/installer') 40 | return unInstallPackage(packageName ?? '') 41 | }) 42 | 43 | program 44 | .command('switch [packageManager]') 45 | .description('switch packageManager') 46 | .action(async (packageManager: String) => { 47 | const { switchPackageManager } = await import('@commands/switch') 48 | return switchPackageManager(packageManager) 49 | }) 50 | 51 | program 52 | .command('save') 53 | .option(' [reName]', 'your templatePath') 54 | .option('-l, --list ', 'your templateListPath') 55 | .description('save template[s]') 56 | .action(async (option, { args }) => { 57 | const { save } = await import('@commands/save') 58 | return save(option, args) 59 | }) 60 | 61 | program 62 | .command('delete ') 63 | .description('delete templateName') 64 | .action(async (templateName: string) => { 65 | const { deleteTemplate } = await import('@commands/delete') 66 | return deleteTemplate(templateName) 67 | }) 68 | 69 | 70 | //解析我们定义的命令并处理参数 71 | program.parse(process.argv) 72 | -------------------------------------------------------------------------------- /lib/template/vue3app/src/components/HelloWorld.vue: -------------------------------------------------------------------------------- 1 | 32 | 33 | 41 | 42 | 43 | 59 | -------------------------------------------------------------------------------- /lib/template/springboot/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | org.springframework.boot 7 | spring-boot-starter-parent 8 | 2.7.14 9 | 10 | 11 | com.xxx 12 | demo 13 | 0.0.1-SNAPSHOT 14 | demo 15 | demo 16 | 17 | 1.8 18 | 19 | 20 | 21 | org.springframework.boot 22 | spring-boot-starter-jdbc 23 | 24 | 25 | org.springframework.boot 26 | spring-boot-starter-web 27 | 28 | 29 | org.mybatis.spring.boot 30 | mybatis-spring-boot-starter 31 | 2.3.1 32 | 33 | 34 | 35 | org.projectlombok 36 | lombok 37 | true 38 | 39 | 40 | org.springframework.boot 41 | spring-boot-starter-test 42 | test 43 | 44 | 45 | org.mybatis.spring.boot 46 | mybatis-spring-boot-starter-test 47 | 2.3.1 48 | test 49 | 50 | 51 | 52 | 53 | 54 | 55 | org.springframework.boot 56 | spring-boot-maven-plugin 57 | 58 | 59 | 60 | org.projectlombok 61 | lombok 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | -------------------------------------------------------------------------------- /lib/template/vue2app/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "vue2app", 3 | "version": "1.0.0", 4 | "description": "A Vue.js project", 5 | "author": "19124307779 ", 6 | "private": true, 7 | "scripts": { 8 | "dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js", 9 | "start": "npm run dev", 10 | "lint": "eslint --ext .js,.vue src", 11 | "build": "node build/build.js" 12 | }, 13 | "dependencies": { 14 | "vue": "^2.5.2", 15 | "vue-router": "^3.0.1" 16 | }, 17 | "devDependencies": { 18 | "autoprefixer": "^7.1.2", 19 | "babel-core": "^6.22.1", 20 | "babel-eslint": "^8.2.1", 21 | "babel-helper-vue-jsx-merge-props": "^2.0.3", 22 | "babel-loader": "^7.1.1", 23 | "babel-plugin-syntax-jsx": "^6.18.0", 24 | "babel-plugin-transform-runtime": "^6.22.0", 25 | "babel-plugin-transform-vue-jsx": "^3.5.0", 26 | "babel-preset-env": "^1.3.2", 27 | "babel-preset-stage-2": "^6.22.0", 28 | "chalk": "^2.0.1", 29 | "copy-webpack-plugin": "^4.0.1", 30 | "css-loader": "^0.28.0", 31 | "eslint": "^4.15.0", 32 | "eslint-config-standard": "^10.2.1", 33 | "eslint-friendly-formatter": "^3.0.0", 34 | "eslint-loader": "^1.7.1", 35 | "eslint-plugin-import": "^2.7.0", 36 | "eslint-plugin-node": "^5.2.0", 37 | "eslint-plugin-promise": "^3.4.0", 38 | "eslint-plugin-standard": "^3.0.1", 39 | "eslint-plugin-vue": "^4.0.0", 40 | "extract-text-webpack-plugin": "^3.0.0", 41 | "file-loader": "^1.1.4", 42 | "friendly-errors-webpack-plugin": "^1.6.1", 43 | "html-webpack-plugin": "^2.30.1", 44 | "node-notifier": "^5.1.2", 45 | "optimize-css-assets-webpack-plugin": "^3.2.0", 46 | "ora": "^1.2.0", 47 | "portfinder": "^1.0.13", 48 | "postcss-import": "^11.0.0", 49 | "postcss-loader": "^2.0.8", 50 | "postcss-url": "^7.2.1", 51 | "rimraf": "^2.6.0", 52 | "semver": "^5.3.0", 53 | "shelljs": "^0.7.6", 54 | "uglifyjs-webpack-plugin": "^1.1.1", 55 | "url-loader": "^0.5.8", 56 | "vue-loader": "^13.3.0", 57 | "vue-style-loader": "^3.0.1", 58 | "vue-template-compiler": "^2.5.2", 59 | "webpack": "^3.6.0", 60 | "webpack-bundle-analyzer": "^2.9.0", 61 | "webpack-dev-server": "^2.9.1", 62 | "webpack-merge": "^4.1.0" 63 | }, 64 | "engines": { 65 | "node": ">= 6.0.0", 66 | "npm": ">= 3.0.0" 67 | }, 68 | "browserslist": [ 69 | "> 1%", 70 | "last 2 versions", 71 | "not ie <= 8" 72 | ] 73 | } 74 | -------------------------------------------------------------------------------- /lib/template/vue2app/src/components/HelloWorld.vue: -------------------------------------------------------------------------------- 1 | 85 | 86 | 96 | 97 | 98 | 114 | -------------------------------------------------------------------------------- /lib/template/vue2app/config/index.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | // Template version: 1.3.1 3 | // see http://vuejs-templates.github.io/webpack for documentation. 4 | 5 | const path = require('path') 6 | 7 | module.exports = { 8 | dev: { 9 | 10 | // Paths 11 | assetsSubDirectory: 'static', 12 | assetsPublicPath: '/', 13 | proxyTable: {}, 14 | 15 | // Various Dev Server settings 16 | host: 'localhost', // can be overwritten by process.env.HOST 17 | port: 8080, // can be overwritten by process.env.PORT, if port is in use, a free one will be determined 18 | autoOpenBrowser: false, 19 | errorOverlay: true, 20 | notifyOnErrors: true, 21 | poll: false, // https://webpack.js.org/configuration/dev-server/#devserver-watchoptions- 22 | 23 | // Use Eslint Loader? 24 | // If true, your code will be linted during bundling and 25 | // linting errors and warnings will be shown in the console. 26 | useEslint: true, 27 | // If true, eslint errors and warnings will also be shown in the error overlay 28 | // in the browser. 29 | showEslintErrorsInOverlay: false, 30 | 31 | /** 32 | * Source Maps 33 | */ 34 | 35 | // https://webpack.js.org/configuration/devtool/#development 36 | devtool: 'cheap-module-eval-source-map', 37 | 38 | // If you have problems debugging vue-files in devtools, 39 | // set this to false - it *may* help 40 | // https://vue-loader.vuejs.org/en/options.html#cachebusting 41 | cacheBusting: true, 42 | 43 | cssSourceMap: true 44 | }, 45 | 46 | build: { 47 | // Template for index.html 48 | index: path.resolve(__dirname, '../dist/index.html'), 49 | 50 | // Paths 51 | assetsRoot: path.resolve(__dirname, '../dist'), 52 | assetsSubDirectory: 'static', 53 | assetsPublicPath: '/', 54 | 55 | /** 56 | * Source Maps 57 | */ 58 | 59 | productionSourceMap: true, 60 | // https://webpack.js.org/configuration/devtool/#production 61 | devtool: '#source-map', 62 | 63 | // Gzip off by default as many popular static hosts such as 64 | // Surge or Netlify already gzip all static assets for you. 65 | // Before setting to `true`, make sure to: 66 | // npm install --save-dev compression-webpack-plugin 67 | productionGzip: false, 68 | productionGzipExtensions: ['js', 'css'], 69 | 70 | // Run the build command with an extra argument to 71 | // View the bundle analyzer report after build finishes: 72 | // `npm run build --report` 73 | // Set to `true` or `false` to always turn it on or off 74 | bundleAnalyzerReport: process.env.npm_config_report 75 | } 76 | } 77 | -------------------------------------------------------------------------------- /lib/template/vue2app/build/webpack.base.conf.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | const path = require('path') 3 | const utils = require('./utils') 4 | const config = require('../config') 5 | const vueLoaderConfig = require('./vue-loader.conf') 6 | 7 | function resolve (dir) { 8 | return path.join(__dirname, '..', dir) 9 | } 10 | 11 | const createLintingRule = () => ({ 12 | test: /\.(js|vue)$/, 13 | loader: 'eslint-loader', 14 | enforce: 'pre', 15 | include: [resolve('src'), resolve('test')], 16 | options: { 17 | formatter: require('eslint-friendly-formatter'), 18 | emitWarning: !config.dev.showEslintErrorsInOverlay 19 | } 20 | }) 21 | 22 | module.exports = { 23 | context: path.resolve(__dirname, '../'), 24 | entry: { 25 | app: './src/main.js' 26 | }, 27 | output: { 28 | path: config.build.assetsRoot, 29 | filename: '[name].js', 30 | publicPath: process.env.NODE_ENV === 'production' 31 | ? config.build.assetsPublicPath 32 | : config.dev.assetsPublicPath 33 | }, 34 | resolve: { 35 | extensions: ['.js', '.vue', '.json'], 36 | alias: { 37 | 'vue$': 'vue/dist/vue.esm.js', 38 | '@': resolve('src'), 39 | } 40 | }, 41 | module: { 42 | rules: [ 43 | ...(config.dev.useEslint ? [createLintingRule()] : []), 44 | { 45 | test: /\.vue$/, 46 | loader: 'vue-loader', 47 | options: vueLoaderConfig 48 | }, 49 | { 50 | test: /\.js$/, 51 | loader: 'babel-loader', 52 | include: [resolve('src'), resolve('test'), resolve('node_modules/webpack-dev-server/client')] 53 | }, 54 | { 55 | test: /\.(png|jpe?g|gif|svg)(\?.*)?$/, 56 | loader: 'url-loader', 57 | options: { 58 | limit: 10000, 59 | name: utils.assetsPath('img/[name].[hash:7].[ext]') 60 | } 61 | }, 62 | { 63 | test: /\.(mp4|webm|ogg|mp3|wav|flac|aac)(\?.*)?$/, 64 | loader: 'url-loader', 65 | options: { 66 | limit: 10000, 67 | name: utils.assetsPath('media/[name].[hash:7].[ext]') 68 | } 69 | }, 70 | { 71 | test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/, 72 | loader: 'url-loader', 73 | options: { 74 | limit: 10000, 75 | name: utils.assetsPath('fonts/[name].[hash:7].[ext]') 76 | } 77 | } 78 | ] 79 | }, 80 | node: { 81 | // prevent webpack from injecting useless setImmediate polyfill because Vue 82 | // source contains it (although only uses it if it's native). 83 | setImmediate: false, 84 | // prevent webpack from injecting mocks to Node native modules 85 | // that does not make sense for the client 86 | dgram: 'empty', 87 | fs: 'empty', 88 | net: 'empty', 89 | tls: 'empty', 90 | child_process: 'empty' 91 | } 92 | } 93 | -------------------------------------------------------------------------------- /lib/template/vue2app/build/utils.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | const path = require('path') 3 | const config = require('../config') 4 | const ExtractTextPlugin = require('extract-text-webpack-plugin') 5 | const packageConfig = require('../package.json') 6 | 7 | exports.assetsPath = function (_path) { 8 | const assetsSubDirectory = process.env.NODE_ENV === 'production' 9 | ? config.build.assetsSubDirectory 10 | : config.dev.assetsSubDirectory 11 | 12 | return path.posix.join(assetsSubDirectory, _path) 13 | } 14 | 15 | exports.cssLoaders = function (options) { 16 | options = options || {} 17 | 18 | const cssLoader = { 19 | loader: 'css-loader', 20 | options: { 21 | sourceMap: options.sourceMap 22 | } 23 | } 24 | 25 | const postcssLoader = { 26 | loader: 'postcss-loader', 27 | options: { 28 | sourceMap: options.sourceMap 29 | } 30 | } 31 | 32 | // generate loader string to be used with extract text plugin 33 | function generateLoaders (loader, loaderOptions) { 34 | const loaders = options.usePostCSS ? [cssLoader, postcssLoader] : [cssLoader] 35 | 36 | if (loader) { 37 | loaders.push({ 38 | loader: loader + '-loader', 39 | options: Object.assign({}, loaderOptions, { 40 | sourceMap: options.sourceMap 41 | }) 42 | }) 43 | } 44 | 45 | // Extract CSS when that option is specified 46 | // (which is the case during production build) 47 | if (options.extract) { 48 | return ExtractTextPlugin.extract({ 49 | use: loaders, 50 | fallback: 'vue-style-loader' 51 | }) 52 | } else { 53 | return ['vue-style-loader'].concat(loaders) 54 | } 55 | } 56 | 57 | // https://vue-loader.vuejs.org/en/configurations/extract-css.html 58 | return { 59 | css: generateLoaders(), 60 | postcss: generateLoaders(), 61 | less: generateLoaders('less'), 62 | sass: generateLoaders('sass', { indentedSyntax: true }), 63 | scss: generateLoaders('sass'), 64 | stylus: generateLoaders('stylus'), 65 | styl: generateLoaders('stylus') 66 | } 67 | } 68 | 69 | // Generate loaders for standalone style files (outside of .vue) 70 | exports.styleLoaders = function (options) { 71 | const output = [] 72 | const loaders = exports.cssLoaders(options) 73 | 74 | for (const extension in loaders) { 75 | const loader = loaders[extension] 76 | output.push({ 77 | test: new RegExp('\\.' + extension + '$'), 78 | use: loader 79 | }) 80 | } 81 | 82 | return output 83 | } 84 | 85 | exports.createNotifierCallback = () => { 86 | const notifier = require('node-notifier') 87 | 88 | return (severity, errors) => { 89 | if (severity !== 'error') return 90 | 91 | const error = errors[0] 92 | const filename = error.file && error.file.split('!').pop() 93 | 94 | notifier.notify({ 95 | title: packageConfig.name, 96 | message: severity + ': ' + error.name, 97 | subtitle: filename || '', 98 | icon: path.join(__dirname, 'logo.png') 99 | }) 100 | } 101 | } 102 | -------------------------------------------------------------------------------- /lib/template/vue2app/build/webpack.dev.conf.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | const utils = require('./utils') 3 | const webpack = require('webpack') 4 | const config = require('../config') 5 | const merge = require('webpack-merge') 6 | const path = require('path') 7 | const baseWebpackConfig = require('./webpack.base.conf') 8 | const CopyWebpackPlugin = require('copy-webpack-plugin') 9 | const HtmlWebpackPlugin = require('html-webpack-plugin') 10 | const FriendlyErrorsPlugin = require('friendly-errors-webpack-plugin') 11 | const portfinder = require('portfinder') 12 | 13 | const HOST = process.env.HOST 14 | const PORT = process.env.PORT && Number(process.env.PORT) 15 | 16 | const devWebpackConfig = merge(baseWebpackConfig, { 17 | module: { 18 | rules: utils.styleLoaders({ sourceMap: config.dev.cssSourceMap, usePostCSS: true }) 19 | }, 20 | // cheap-module-eval-source-map is faster for development 21 | devtool: config.dev.devtool, 22 | 23 | // these devServer options should be customized in /config/index.js 24 | devServer: { 25 | clientLogLevel: 'warning', 26 | historyApiFallback: { 27 | rewrites: [ 28 | { from: /.*/, to: path.posix.join(config.dev.assetsPublicPath, 'index.html') }, 29 | ], 30 | }, 31 | hot: true, 32 | contentBase: false, // since we use CopyWebpackPlugin. 33 | compress: true, 34 | host: HOST || config.dev.host, 35 | port: PORT || config.dev.port, 36 | open: config.dev.autoOpenBrowser, 37 | overlay: config.dev.errorOverlay 38 | ? { warnings: false, errors: true } 39 | : false, 40 | publicPath: config.dev.assetsPublicPath, 41 | proxy: config.dev.proxyTable, 42 | quiet: true, // necessary for FriendlyErrorsPlugin 43 | watchOptions: { 44 | poll: config.dev.poll, 45 | } 46 | }, 47 | plugins: [ 48 | new webpack.DefinePlugin({ 49 | 'process.env': require('../config/dev.env') 50 | }), 51 | new webpack.HotModuleReplacementPlugin(), 52 | new webpack.NamedModulesPlugin(), // HMR shows correct file names in console on update. 53 | new webpack.NoEmitOnErrorsPlugin(), 54 | // https://github.com/ampedandwired/html-webpack-plugin 55 | new HtmlWebpackPlugin({ 56 | filename: 'index.html', 57 | template: 'index.html', 58 | inject: true 59 | }), 60 | // copy custom static assets 61 | new CopyWebpackPlugin([ 62 | { 63 | from: path.resolve(__dirname, '../static'), 64 | to: config.dev.assetsSubDirectory, 65 | ignore: ['.*'] 66 | } 67 | ]) 68 | ] 69 | }) 70 | 71 | module.exports = new Promise((resolve, reject) => { 72 | portfinder.basePort = process.env.PORT || config.dev.port 73 | portfinder.getPort((err, port) => { 74 | if (err) { 75 | reject(err) 76 | } else { 77 | // publish the new Port, necessary for e2e tests 78 | process.env.PORT = port 79 | // add port to devServer config 80 | devWebpackConfig.devServer.port = port 81 | 82 | // Add FriendlyErrorsPlugin 83 | devWebpackConfig.plugins.push(new FriendlyErrorsPlugin({ 84 | compilationSuccessInfo: { 85 | messages: [`Your application is running here: http://${devWebpackConfig.devServer.host}:${port}`], 86 | }, 87 | onErrors: config.dev.notifyOnErrors 88 | ? utils.createNotifierCallback() 89 | : undefined 90 | })) 91 | 92 | resolve(devWebpackConfig) 93 | } 94 | }) 95 | }) 96 | -------------------------------------------------------------------------------- /lib/template/vue2app/build/webpack.prod.conf.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | const path = require('path') 3 | const utils = require('./utils') 4 | const webpack = require('webpack') 5 | const config = require('../config') 6 | const merge = require('webpack-merge') 7 | const baseWebpackConfig = require('./webpack.base.conf') 8 | const CopyWebpackPlugin = require('copy-webpack-plugin') 9 | const HtmlWebpackPlugin = require('html-webpack-plugin') 10 | const ExtractTextPlugin = require('extract-text-webpack-plugin') 11 | const OptimizeCSSPlugin = require('optimize-css-assets-webpack-plugin') 12 | const UglifyJsPlugin = require('uglifyjs-webpack-plugin') 13 | 14 | const env = require('../config/prod.env') 15 | 16 | const webpackConfig = merge(baseWebpackConfig, { 17 | module: { 18 | rules: utils.styleLoaders({ 19 | sourceMap: config.build.productionSourceMap, 20 | extract: true, 21 | usePostCSS: true 22 | }) 23 | }, 24 | devtool: config.build.productionSourceMap ? config.build.devtool : false, 25 | output: { 26 | path: config.build.assetsRoot, 27 | filename: utils.assetsPath('js/[name].[chunkhash].js'), 28 | chunkFilename: utils.assetsPath('js/[id].[chunkhash].js') 29 | }, 30 | plugins: [ 31 | // http://vuejs.github.io/vue-loader/en/workflow/production.html 32 | new webpack.DefinePlugin({ 33 | 'process.env': env 34 | }), 35 | new UglifyJsPlugin({ 36 | uglifyOptions: { 37 | compress: { 38 | warnings: false 39 | } 40 | }, 41 | sourceMap: config.build.productionSourceMap, 42 | parallel: true 43 | }), 44 | // extract css into its own file 45 | new ExtractTextPlugin({ 46 | filename: utils.assetsPath('css/[name].[contenthash].css'), 47 | // Setting the following option to `false` will not extract CSS from codesplit chunks. 48 | // Their CSS will instead be inserted dynamically with style-loader when the codesplit chunk has been loaded by webpack. 49 | // It's currently set to `true` because we are seeing that sourcemaps are included in the codesplit bundle as well when it's `false`, 50 | // increasing file size: https://github.com/vuejs-templates/webpack/issues/1110 51 | allChunks: true, 52 | }), 53 | // Compress extracted CSS. We are using this plugin so that possible 54 | // duplicated CSS from different components can be deduped. 55 | new OptimizeCSSPlugin({ 56 | cssProcessorOptions: config.build.productionSourceMap 57 | ? { safe: true, map: { inline: false } } 58 | : { safe: true } 59 | }), 60 | // generate dist index.html with correct asset hash for caching. 61 | // you can customize output by editing /index.html 62 | // see https://github.com/ampedandwired/html-webpack-plugin 63 | new HtmlWebpackPlugin({ 64 | filename: config.build.index, 65 | template: 'index.html', 66 | inject: true, 67 | minify: { 68 | removeComments: true, 69 | collapseWhitespace: true, 70 | removeAttributeQuotes: true 71 | // more options: 72 | // https://github.com/kangax/html-minifier#options-quick-reference 73 | }, 74 | // necessary to consistently work with multiple chunks via CommonsChunkPlugin 75 | chunksSortMode: 'dependency' 76 | }), 77 | // keep module.id stable when vendor modules does not change 78 | new webpack.HashedModuleIdsPlugin(), 79 | // enable scope hoisting 80 | new webpack.optimize.ModuleConcatenationPlugin(), 81 | // split vendor js into its own file 82 | new webpack.optimize.CommonsChunkPlugin({ 83 | name: 'vendor', 84 | minChunks (module) { 85 | // any required modules inside node_modules are extracted to vendor 86 | return ( 87 | module.resource && 88 | /\.js$/.test(module.resource) && 89 | module.resource.indexOf( 90 | path.join(__dirname, '../node_modules') 91 | ) === 0 92 | ) 93 | } 94 | }), 95 | // extract webpack runtime and module manifest to its own file in order to 96 | // prevent vendor hash from being updated whenever app bundle is updated 97 | new webpack.optimize.CommonsChunkPlugin({ 98 | name: 'manifest', 99 | minChunks: Infinity 100 | }), 101 | // This instance extracts shared chunks from code splitted chunks and bundles them 102 | // in a separate chunk, similar to the vendor chunk 103 | // see: https://webpack.js.org/plugins/commons-chunk-plugin/#extra-async-commons-chunk 104 | new webpack.optimize.CommonsChunkPlugin({ 105 | name: 'app', 106 | async: 'vendor-async', 107 | children: true, 108 | minChunks: 3 109 | }), 110 | 111 | // copy custom static assets 112 | new CopyWebpackPlugin([ 113 | { 114 | from: path.resolve(__dirname, '../static'), 115 | to: config.build.assetsSubDirectory, 116 | ignore: ['.*'] 117 | } 118 | ]) 119 | ] 120 | }) 121 | 122 | if (config.build.productionGzip) { 123 | const CompressionWebpackPlugin = require('compression-webpack-plugin') 124 | 125 | webpackConfig.plugins.push( 126 | new CompressionWebpackPlugin({ 127 | asset: '[path].gz[query]', 128 | algorithm: 'gzip', 129 | test: new RegExp( 130 | '\\.(' + 131 | config.build.productionGzipExtensions.join('|') + 132 | ')$' 133 | ), 134 | threshold: 10240, 135 | minRatio: 0.8 136 | }) 137 | ) 138 | } 139 | 140 | if (config.build.bundleAnalyzerReport) { 141 | const BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPlugin 142 | webpackConfig.plugins.push(new BundleAnalyzerPlugin()) 143 | } 144 | 145 | module.exports = webpackConfig 146 | --------------------------------------------------------------------------------