Merge pull request #1 from VoloshchenkoAl/develop

Merge develop into master

Author: VoloshchenkoAl

.github/workflows/npm-publish.yml

@@ -0,0 +1,18 @@
+name: Publish npm package
+
+on:
+    release:
+        types: [created]
+
+jobs:
+    publish-npm:
+        needs: check
+        steps:
+            - uses: actions/checkout@v2
+            - uses: actions/setup-node@v1
+              with:
+                  node-version: 12
+                  registry-url: https://registry.npmjs.org/
+            - run: npm publish
+              env:
+                  NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

License.md

@@ -0,0 +1,9 @@
+# The MIT License
+
+Copyright 2020 Aleksandr Voloshchenko, contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,15 @@
+# Create TS Web App
+
+Command line tool to help you create web app with TypeScript support
+
+## Quick Overview
+
+```sh
+npx create-ts-web-app my-app
+cd my-app
+npm start
+```
+
+Then open your browser with url `http://localhost:8080/` to see your app
+
+For production build use command `npm run build`

bin/index.js

@@ -12,26 +12,24 @@ let projectName;
 program
     .version(packageJson.version)
     .arguments('<project-directory>')
-    .action(name => {
+    .action((name) => {
         projectName = name;
     })
     .parse(process.arg);
 
 createApp({ name: projectName });
 
-
 function createApp({ name }) {
     console.log('Installing...');
 
     const root = path.resolve(name);
     const templateDirPath = path.resolve(__dirname, '../', 'template');
     fs.ensureDirSync(root);
     fs.copySync(templateDirPath, root);
-    fs.writeFileSync(
-        path.join(root, 'package.json'),
-        updatePackageJson()
-    );
+    fs.writeFileSync(path.join(root, 'package.json'), updatePackageJson());
     install({ cwd: root });
+
+    console.log('Done');
 }
 
 function updatePackageJson() {
@@ -43,4 +41,4 @@ function updatePackageJson() {
 
 function install({ cwd }) {
     spawnSync('npm', ['install'], { cwd });
-}
+}

package.json

@@ -1,14 +1,29 @@
 {
-  "name": "create-ts-web-app",
-  "version": "0.0.1",
-  "description": "Create base template for ts web app",
-  "license": "MIT",
-  "bin": {
-    "create-ts-web-app": "./bin/index.js"
-  },
-  "author": "Aleksandr Voloshchenko <[email protected]>",
-  "dependencies": {
-    "commander": "^5.0.0",
-    "fs-extra": "^9.0.0"
-  }
+    "name": "create-ts-web-app",
+    "version": "0.0.2",
+    "description": "Create web app with typescript support",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/VoloshchenkoAl/create-ts-web-app.git"
+    },
+    "license": "MIT",
+    "bin": {
+        "create-ts-web-app": "./bin/index.js"
+    },
+    "author": "Aleksandr Voloshchenko <[email protected]>",
+    "dependencies": {
+        "commander": "^5.0.0",
+        "fs-extra": "^9.0.0"
+    },
+    "files": [
+        "bin",
+        "template"
+    ],
+    "bugs": {
+        "url": "https://github.com/VoloshchenkoAl/create-ts-web-app/issues"
+    },
+    "keywords": [
+        "typescript",
+        "create-web-app"
+    ]
 }

template/package.json

@@ -1,27 +1,27 @@
 {
-  "name": "create-ts-web-app",
-  "version": "1.0.0",
-  "description": "",
-  "private": true,
-  "scripts": {
-    "build": "webpack --config webpack.prod.config.js",
-    "start": "webpack-dev-server --open"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "devDependencies": {
-    "clean-webpack-plugin": "^3.0.0",
-    "css-loader": "^3.5.2",
-    "html-webpack-plugin": "^4.2.0",
-    "mini-css-extract-plugin": "^0.9.0",
-    "sass": "^1.26.3",
-    "sass-loader": "^8.0.2",
-    "style-loader": "^1.1.3",
-    "ts-loader": "^7.0.0",
-    "typescript": "^3.8.3",
-    "webpack": "^4.42.1",
-    "webpack-cli": "^3.3.11",
-    "webpack-dev-server": "^3.10.3"
-  }
+    "name": "create-ts-web-app",
+    "version": "1.0.0",
+    "description": "",
+    "private": true,
+    "scripts": {
+        "build": "webpack --config webpack.prod.config.js",
+        "start": "webpack-dev-server --open"
+    },
+    "keywords": [],
+    "author": "",
+    "license": "ISC",
+    "devDependencies": {
+        "clean-webpack-plugin": "^3.0.0",
+        "css-loader": "^3.6.0",
+        "html-webpack-plugin": "^4.5.0",
+        "mini-css-extract-plugin": "^1.0.0",
+        "sass": "^1.27.0",
+        "sass-loader": "^8.0.2",
+        "style-loader": "^1.3.0",
+        "ts-loader": "^8.0.5",
+        "typescript": "^4.0.3",
+        "webpack": "^4.44.2",
+        "webpack-cli": "^3.3.12",
+        "webpack-dev-server": "^3.11.0"
+    }
 }

template/webpack.config.js

@@ -18,25 +18,22 @@ module.exports = {
             },
             {
                 test: /\.s[ac]ss$/,
-                use: [
-                    'style-loader',
-                    'css-loader',
-                    'sass-loader',
-                ]
-            }
-        ]
+                use: ['style-loader', 'css-loader', 'sass-loader'],
+            },
+        ],
     },
     devServer: {
         contentBase: path.join(__dirname, 'src'),
         hot: true,
+        port: 8080,
     },
     resolve: {
         extensions: ['.ts', '.js', '.json'],
-        modules: ['node_modules']
+        modules: ['node_modules'],
     },
     plugins: [
         new HtmlWebpackPlugin({
-            template: path.join(__dirname, 'public', 'index.html')
+            template: path.join(__dirname, 'public', 'index.html'),
         }),
-    ]
+    ],
 };

template/webpack.prod.config.js

@@ -19,25 +19,21 @@ module.exports = {
             },
             {
                 test: /\.s[ac]ss$/,
-                use: [
-                    MiniCssExtractPlugin.loader,
-                    'css-loader',
-                    'sass-loader',
-                ]
-            }
-        ]
+                use: [MiniCssExtractPlugin.loader, 'css-loader', 'sass-loader'],
+            },
+        ],
     },
     resolve: {
         extensions: ['.ts', '.js', '.json'],
-        modules: ['node_modules']
+        modules: ['node_modules'],
     },
     plugins: [
         new CleanWebpackPlugin(),
         new MiniCssExtractPlugin({
             filename: '[name].[hash].css',
         }),
         new HtmlWebpackPlugin({
-            template: path.join(__dirname, 'public', 'index.html')
+            template: path.join(__dirname, 'public', 'index.html'),
         }),
-    ]
+    ],
 };