create-tateru-cli 0.2.0 → 0.3.1

package/README.md

@@ -1,5 +1,9 @@
 # Create Tateru CLI project
 
+[![NPM Version](https://img.shields.io/npm/v/create-tateru-cli)](https://www.npmjs.com/package/create-tateru-cli)
+[![GitHub Release](https://img.shields.io/github/v/release/danielsitek/tateru-create-tateru-cli)](https://github.com/danielsitek/tateru-create-tateru-cli/releases)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/5b3efe68fa4d4b69b2bd00c9436954cb)](https://app.codacy.com/gh/danielsitek/tateru-create-tateru-cli/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
+
 Simplest way to create a new project using [tateru-cli](https://github.com/danielsitek/tateru-cli).
 
 ## Usage
@@ -28,3 +32,4 @@ Currently supported templates include:
 
 -   If the destination directory is not empty, the script will exit with an error.
 -   Ensure the template name is valid; otherwise, the script will notify you.
+-   Templates should use `_gitignore` instead of `.gitignore`. The script will automatically rename `_gitignore` to `.gitignore` during the copy process.

package/lib/index.js

@@ -16,8 +16,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const node_path_1 = __importDefault(require("node:path"));
 const promises_1 = require("node:fs/promises");
 const node_fs_1 = require("node:fs");
-const cli_1 = require("./cli/cli");
 const promises_2 = __importDefault(require("node:readline/promises"));
+const cli_1 = require("./cli/cli");
+const renameFiles = {
+    _gitignore: '.gitignore',
+};
 const getTemplatePath = (template) => {
     return node_path_1.default.resolve(__dirname, '..', 'templates', `template-${template}`);
 };
@@ -51,9 +54,24 @@ const ensureDirectoryEmpty = (directory) => __awaiter(void 0, void 0, void 0, fu
         yield (0, promises_1.mkdir)(directory, { recursive: true });
     }
 });
+const copyTemplateFiltered = (src, dest) => __awaiter(void 0, void 0, void 0, function* () {
+    const stats = yield (0, promises_1.stat)(src);
+    if (stats.isDirectory()) {
+        yield (0, promises_1.mkdir)(dest, { recursive: true });
+        const entries = yield (0, promises_1.readdir)(src);
+        for (const entry of entries) {
+            const srcPath = node_path_1.default.join(src, entry);
+            const destPath = node_path_1.default.join(dest, renameFiles[entry] || entry);
+            yield copyTemplateFiltered(srcPath, destPath);
+        }
+    }
+    else {
+        yield (0, promises_1.copyFile)(src, dest);
+    }
+});
 const copyTemplate = (templatePath, destinationPath) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        yield (0, promises_1.cp)(templatePath, destinationPath, { recursive: true });
+        yield copyTemplateFiltered(templatePath, destinationPath);
     }
     catch (error) {
         throw new Error([
@@ -73,7 +91,7 @@ Done. Template successfully copied. Now run:
 
 cd ${directory}
 npm install
-npm start
+npm run dev
 `;
 };
 const init = () => __awaiter(void 0, void 0, void 0, function* () {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-tateru-cli",
   "description": "Create basic Tateru CLI project from template files",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "bin": {
     "create-tateru-cli": "./lib/index.js"
   },
@@ -13,8 +13,9 @@
   "scripts": {
     "build": "tsc",
     "clean": "rm -rf lib",
+    "clean:templates": "rm -rf templates/**/node_modules && rm -rf templates/**/dist",
     "typecheck": "tsc --noEmit",
-    "prepack": "npm run clean && npm run build"
+    "prepack": "npm run clean && npm run clean:templates && npm run build"
   },
   "keywords": [
     "tateru-cli",

package/templates/template-gulp-vanilla/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "cSpell.words": ["tateru"]
+}

package/templates/template-gulp-vanilla/_gitignore

@@ -0,0 +1,3 @@
+node_modules
+
+dist/

package/templates/template-gulp-vanilla/package-lock.json

@@ -23,9 +23,9 @@
         "gulp": "^5.0.0",
         "gulp-postcss": "^10.0.0",
         "gulp-rename": "^2.0.0",
+        "gulp-tateru-cli": "^0.1.0",
         "postcss": "^8.5.3",
         "postcss-import": "^16.1.0",
-        "tateru-cli": "^1.5.0",
         "webpack": "^5.98.0"
       },
       "engines": {
@@ -4774,6 +4774,22 @@
         "node": ">=4"
       }
     },
+    "node_modules/gulp-tateru-cli": {
+      "version": "0.1.0",
+      "resolved": "https://registry.npmjs.org/gulp-tateru-cli/-/gulp-tateru-cli-0.1.0.tgz",
+      "integrity": "sha512-Sxas8LrMChMjMReM1k9W7l37TuzdqVCqbjFdCpAZ7SbDVi6IOUFhlUv8uRfFmwU/1tTN+Khf8uqCG+22tbKQEA==",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "plugin-error": "^2.0.1",
+        "tateru-cli": "^1.5.0",
+        "through2": "^4.0.2",
+        "vinyl": "^3.0.0"
+      },
+      "engines": {
+        "node": ">=14"
+      }
+    },
     "node_modules/gulplog": {
       "version": "2.2.0",
       "resolved": "https://registry.npmjs.org/gulplog/-/gulplog-2.2.0.tgz",
@@ -7873,6 +7889,16 @@
       "integrity": "sha1-f17oI66AUgfACvLfSoTsP8+lcLQ=",
       "dev": true
     },
+    "node_modules/through2": {
+      "version": "4.0.2",
+      "resolved": "https://registry.npmjs.org/through2/-/through2-4.0.2.tgz",
+      "integrity": "sha512-iOqSav00cVxEEICeD7TjLB1sueEL+81Wpzp2bY17uZjZN0pWZPuo4suZ/61VujxmqSGFfgOcNuTZ85QJwNZQpw==",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "readable-stream": "3"
+      }
+    },
     "node_modules/to-regex-range": {
       "version": "5.0.1",
       "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz",

package/templates/template-gulp-vanilla/package.json

@@ -26,9 +26,9 @@
     "gulp": "^5.0.0",
     "gulp-postcss": "^10.0.0",
     "gulp-rename": "^2.0.0",
+    "gulp-tateru-cli": "^0.1.0",
     "postcss": "^8.5.3",
     "postcss-import": "^16.1.0",
-    "tateru-cli": "^1.5.0",
     "webpack": "^5.98.0"
   },
   "private": true,

package/templates/template-gulp-vanilla/public/assets/favicon/favicon.svg

@@ -0,0 +1,9 @@
+<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 512 512">
+    <mask id="a" width="512" height="512" x="0" y="0" maskUnits="userSpaceOnUse" style="mask-type:alpha">
+        <rect width="512" height="512" fill="#fff" rx="100"/>
+    </mask>
+    <g mask="url(#a)">
+        <path fill="#fff" d="M0 0h512v512H0z"/>
+        <path fill="#3C36EA" d="M414 213h-55l-21 87h53l-14 59h-54l-23 89h-60l22-89h-64l-22 89h-60l22-89H86l14-59h53l22-87h-54l14-59h55l22-90h60l-23 90h65l23-90h60l-23 90h54l-14 59Zm-137 87 22-87h-64l-22 87h64Z"/>
+    </g>
+</svg>

package/templates/template-gulp-vanilla/src/twig/layouts/layout.html.twig

@@ -121,10 +121,10 @@
     {%- endif -%}
     {###############################################}
 
-    <link rel="apple-touch-icon" sizes="180x180" href="{{- app.root -}}assets/favicon/apple-touch-icon.png{{- version_suffix -}}">
-    <link rel="icon" type="image/png" href="{{- app.root -}}assets/favicon/favicon-32x32.png{{- version_suffix -}}" sizes="32x32">
-    <link rel="icon" type="image/png" href="{{- app.root -}}assets/favicon/favicon-16x16.png{{- version_suffix -}}" sizes="16x16">
-    <link rel="shortcut icon" href="{{- app.root -}}assets/favicon/favicon.ico{{- version_suffix -}}">
+    <link rel="apple-touch-icon" sizes="180x180" href="{{- app.root -}}assets/favicon/apple-touch-icon.png{{- version_suffix -}}" />
+    <link rel="icon" type="image/png" href="{{- app.root -}}assets/favicon/favicon-96x96.png{{- version_suffix -}}" sizes="96x96" />
+    <link rel="icon" type="image/svg+xml" href="{{- app.root -}}assets/favicon/favicon.svg{{- version_suffix -}}" />
+    <link rel="shortcut icon" href="{{- app.root -}}assets/favicon/favicon.ico{{- version_suffix -}}" />
     <link rel="manifest" href="{{- app.root -}}site.webmanifest{{- version_suffix -}}" crossorigin="use-credentials">
     <meta name="theme-color" content="#ffffff">
 

package/templates/template-gulp-vanilla/src/twig/views/site.webmanifest.twig

@@ -4,12 +4,12 @@
     "description": "{{- description -}}",
     "icons": [
         {
-            "src": "{{- app.root -}}assets/favicon/android-chrome-192x192.png",
+            "src": "{{- app.root -}}assets/favicon/web-app-manifest-192x192.png",
             "sizes": "192x192",
             "type": "image/png"
         },
         {
-            "src": "{{- app.root -}}assets/favicon/android-chrome-512x512.png",
+            "src": "{{- app.root -}}assets/favicon/web-app-manifest-512x512.png",
             "sizes": "512x512",
             "type": "image/png"
         }

package/templates/template-gulp-vanilla/tasks/tateru.js

@@ -1,25 +1,22 @@
-const { exec } = require('child_process');
-const Logger = require('./helpers/logger');
+const { src, dest } = require('gulp');
+const { gulpTateruCli } = require('gulp-tateru-cli');
+const { ENV_PRODUCTION } = require('./helpers/config');
 
-const log = new Logger({
-  namespace: 'tateru',
-});
+const TATERU_ENV_PRODUCTION = 'prod';
+const TATERU_ENV_DEVELOPMENT = 'dev';
 
-module.exports = function tateru(cb) {
-  return new Promise((resolve) => {
-    exec('npm run tateru', function (error, stdout, stderr) {
-      
-      if (error && stdout) {
-        log.error(stdout);
-      } else if (stdout) {
-        log.info(stdout);
-      }
-      
-      if (stderr) {
-        log.error(stderr);
-      }
+module.exports = function tateru() {
+  /** @type {import('gulp-tateru-cli').GulpTateruCliOptions} */
+  const options = {
+    env:
+      process.env.NODE_ENV === ENV_PRODUCTION
+        ? TATERU_ENV_PRODUCTION
+        : TATERU_ENV_DEVELOPMENT,
+  };
 
-      resolve(cb);
-    })
+  return src(['tateru.config.json'], {
+    cwd: '.',
   })
-}
+    .pipe(gulpTateruCli(options))
+    .pipe(dest('dist'));
+};

package/templates/template-gulp-vanilla/tasks/watch.js

@@ -32,7 +32,7 @@ module.exports = function watch () {
   watchGulp([
     `src/twig/**/*`,
     `src/translations/**/*`,
-    `config.json`,
+    `tateru.config.json`,
   ], tateru);
 
   watchGulp([

package/templates/template-gulp-vanilla/tateru.config.json

@@ -60,7 +60,7 @@
       "full_locale": "cs_CZ"
     },
     "src": "src/twig",
-    "ext": "dist"
+    "ext": ""
   },
   "translations": {
     "cs": {
@@ -76,7 +76,9 @@
         },
         "src": "views/homepage.html.twig",
         "ext": "index.html",
-        "minify": ["prod"]
+        "minify": [
+          "prod"
+        ]
       },
       "humans_txt": {
         "data": {
@@ -108,4 +110,4 @@
       }
     }
   }
-}
+}