@d-zero/create-frontend 5.0.0-alpha.10

package/CHANGELOG.md

@@ -0,0 +1,52 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [5.0.0-alpha.10](https://github.com/d-zero-dev/frontend-env/compare/v5.0.0-alpha.9...v5.0.0-alpha.10) (2024-06-11)
+
+### Bug Fixes
+
+- **scaffold:** 生成ファイルや静的ファイルがリント対象となっていたため除外設定を追加 ([0938636](https://github.com/d-zero-dev/frontend-env/commit/0938636ec260337914eaa4d0ab98aead709164fc))
+
+# [5.0.0-alpha.9](https://github.com/d-zero-dev/frontend-env/compare/v5.0.0-alpha.8...v5.0.0-alpha.9) (2024-06-10)
+
+**Note:** Version bump only for package @d-zero/create-frontend
+
+# [5.0.0-alpha.8](https://github.com/d-zero-dev/frontend-env/compare/v5.0.0-alpha.7...v5.0.0-alpha.8) (2024-05-23)
+
+**Note:** Version bump only for package @d-zero/create-frontend
+
+# [5.0.0-alpha.7](https://github.com/d-zero-dev/frontend-env/compare/v5.0.0-alpha.6...v5.0.0-alpha.7) (2024-05-14)
+
+**Note:** Version bump only for package @d-zero/create-frontend
+
+# [5.0.0-alpha.6](https://github.com/d-zero-dev/frontend-env/compare/v5.0.0-alpha.5...v5.0.0-alpha.6) (2024-05-14)
+
+### Bug Fixes
+
+- **repo:** fix each version ([50d50ad](https://github.com/d-zero-dev/frontend-env/commit/50d50adc605b700389e2945d03b72c5c4a00495a))
+
+# [5.0.0-alpha.5](https://github.com/d-zero-dev/frontend-env/compare/v5.0.0-alpha.4...v5.0.0-alpha.5) (2024-05-14)
+
+**Note:** Version bump only for package @d-zero/create-frontend
+
+# [5.0.0-alpha.4](https://github.com/d-zero-dev/frontend-env/compare/v5.0.0-alpha.2...v5.0.0-alpha.4) (2024-05-14)
+
+**Note:** Version bump only for package @d-zero/create-frontend
+
+# [5.0.0-alpha.2](https://github.com/d-zero-dev/frontend-env/compare/v5.0.0-alpha.1...v5.0.0-alpha.2) (2024-05-14)
+
+### Bug Fixes
+
+- **create-frontend:** fix to read `.gitignore` safely ([b192aa4](https://github.com/d-zero-dev/frontend-env/commit/b192aa4655413b75ee8830163198f016754277c9))
+
+### Features
+
+- **create-frontend:** transform `package.json` as private package ([d0bcbb5](https://github.com/d-zero-dev/frontend-env/commit/d0bcbb57ecb06d850e826b3fb43781aa6716f1e3))
+
+# 5.0.0-alpha.1 (2024-05-14)
+
+### Features
+
+- **repo:** first commit ([8d3d8e5](https://github.com/d-zero-dev/frontend-env/commit/8d3d8e54ba047d5431b958d7f28af026357a4886))

package/README.md

@@ -0,0 +1,17 @@
+# ディーゼロ フロントエンド開発環境インストーラー
+
+## 使い方
+
+### 環境のインストール
+
+空のリポジトリで次のパッケージを実行します。
+
+```shell
+npx @d-zero/create-frontend
+
+# もしくは
+
+yarn create @d-zero/frontend
+```
+
+インストールで展開されるファイルは[`@d-zero/scaffold`](https://github.com/d-zero-dev/frontend-env/blob/main/packages/%40d-zero/scaffold/)に格納されています。

package/index.js

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+import { Plop, run } from 'plop';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+Plop.prepare(
+	{
+		configPath: path.join(__dirname, 'plopfile.js'),
+	},
+	(env) =>
+		Plop.execute(
+			{
+				...env,
+				dest: process.cwd(),
+			},
+			run,
+		),
+);

package/index.spec.js

@@ -0,0 +1,119 @@
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+
+import { execa } from 'execa';
+import { describe, test, expect, beforeEach } from 'vitest';
+
+function getName(task) {
+	return encodeURIComponent(`${task.suite.name}_${task.name}`.toLowerCase());
+}
+
+beforeEach((ctx) => {
+	ctx.tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'test-'));
+});
+
+describe('CLI', () => {
+	test('npx', async ({ tmpDir, task }) => {
+		const dir = path.join(tmpDir, getName(task));
+		const { stdout } = await execa(
+			'npx',
+			[
+				'@d-zero/create-frontend',
+				'--type',
+				'burger',
+				'--dir',
+				dir,
+				'--no-install',
+				'--silent',
+			],
+			{
+				failed: true,
+				env: {
+					NODE_NO_WARNINGS: '1',
+				},
+			},
+		);
+		expect(stdout.replaceAll(path.sep, '/').split('\n')).toStrictEqual([
+			`✔  ++ ${dir}/tsconfig.json`,
+			`✔  ++ ${dir}/package.json`,
+			`✔  ++ ${dir}/lint-staged.config.mjs`,
+			`✔  ++ ${dir}/eleventy.config.cjs`,
+			`✔  ++ ${dir}/cspell.json`,
+			`✔  ++ ${dir}/README.md`,
+			`✔  ++ ${dir}/CHANGELOG.md`,
+			`✔  ++ ${dir}/.textlintrc.js`,
+			`✔  ++ ${dir}/.stylelintrc`,
+			`✔  ++ ${dir}/.pug-lintrc`,
+			`✔  ++ ${dir}/.prettierrc.mjs`,
+			`✔  ++ ${dir}/.prettierignore`,
+			`✔  ++ ${dir}/.postcssrc.js`,
+			`✔  ++ ${dir}/.npmignore`,
+			`✔  ++ ${dir}/.markuplintrc`,
+			`✔  ++ ${dir}/.gitignore`,
+			`✔  ++ ${dir}/.eslintrc.cjs`,
+			`✔  ++ ${dir}/.editorconfig`,
+			`✔  ++ ${dir}/__assets/htdocs/index.pug`,
+			`✔  ++ ${dir}/__assets/htdocs/.eslintrc`,
+			`✔  ++ ${dir}/__assets/htdocs/js/script.ts`,
+			`✔  ++ ${dir}/__assets/htdocs/css/style.scss`,
+			`✔  ++ ${dir}/__assets/htdocs/__tmpl/index.pug`,
+			`✔  ++ ${dir}/__assets/htdocs/__tmpl/302_form_complete.pug`,
+			`✔  ++ ${dir}/__assets/htdocs/__tmpl/301_form_confirm.pug`,
+			`✔  ++ ${dir}/__assets/htdocs/__tmpl/300_form_input.pug`,
+			`✔  ++ ${dir}/__assets/htdocs/__tmpl/210_blog_index.pug`,
+			`✔  ++ ${dir}/__assets/htdocs/__tmpl/200_blog_index.pug`,
+			`✔  ++ ${dir}/__assets/htdocs/__tmpl/100_sub.pug`,
+			`✔  ++ ${dir}/__assets/htdocs/__tmpl/000_home.pug`,
+			`✔  ++ ${dir}/__assets/htdocs/__tmpl/.markuplintrc`,
+			`✔  ++ ${dir}/__assets/htdocs/@static/empty`,
+			`✔  ++ ${dir}/__assets/htdocs/@static/img/empty`,
+			`✔  ++ ${dir}/__assets/_libs/.markuplintrc`,
+			`✔  ++ ${dir}/__assets/_libs/style/theme/_index.scss`,
+			`✔  ++ ${dir}/__assets/_libs/style/theme/_font.scss`,
+			`✔  ++ ${dir}/__assets/_libs/style/theme/_dimension.scss`,
+			`✔  ++ ${dir}/__assets/_libs/style/theme/_color.scss`,
+			`✔  ++ ${dir}/__assets/_libs/style/general/_img.scss`,
+			`✔  ++ ${dir}/__assets/_libs/style/general/_button.scss`,
+			`✔  ++ ${dir}/__assets/_libs/style/general/_body.scss`,
+			`✔  ++ ${dir}/__assets/_libs/style/general/_all.scss`,
+			`✔  ++ ${dir}/__assets/_libs/style/base/_root.scss`,
+			`✔  ++ ${dir}/__assets/_libs/script/index.ts`,
+			`✔  ++ ${dir}/__assets/_libs/mixin/meta.pug`,
+			`✔  ++ ${dir}/__assets/_libs/img/bg-repeat-01.gif`,
+			`✔  ++ ${dir}/__assets/_libs/img/bg-arrow.svg`,
+			`✔  ++ ${dir}/__assets/_libs/data/data.yml`,
+			`✔  ++ ${dir}/__assets/_libs/data/blocks.html`,
+			`✔  ++ ${dir}/__assets/_libs/data/blocks.cjs`,
+			`✔  ++ ${dir}/__assets/_libs/data/blocks-burger.html`,
+			`✔  ++ ${dir}/__assets/_libs/data/.markuplintrc`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-title-page.scss`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-title-page.pug`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-pagination.scss`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-pagination.pug`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-page-sub.scss`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-page-home.scss`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-nav-sitemap.scss`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-nav-sitemap.pug`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-nav-global.scss`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-nav-global.pug`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-nav-breadcrumb.scss`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-nav-breadcrumb.pug`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-media.scss`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-media.pug`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-media-list.scss`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-header.scss`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-header.pug`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-footer.scss`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-footer.pug`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-content-main.scss`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-content-index.scss`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-card.scss`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-card.pug`,
+			`✔  ++ ${dir}/__assets/_libs/component/_c-card-list.scss`,
+			`✔  ++ ${dir}/.vscode/settings.json`,
+			`✔  ++ ${dir}/.vscode/extensions.json`,
+			'✔  Install dependencies : skipped',
+		]);
+	});
+});

package/locale.js

@@ -0,0 +1,18 @@
+import { I18n } from 'i18n-js/dist/require/index.js';
+
+const i18n = new I18n({
+	en: {
+		["What's the type of project?"]: "What's the type of project?",
+		['Destination path']: 'Destination path',
+		['Install dependencies with yarn?']: 'Install dependencies with yarn?',
+	},
+	ja: {
+		["What's the type of project?"]: 'プロジェクトの種類',
+		['Destination path']: '出力先パス',
+		['Install dependencies with yarn?']: '依存関係をyarnでインストールしますか？',
+	},
+});
+
+i18n.locale = process.env.LANG?.slice(0, 2) ?? 'en';
+
+export const t = (strings) => i18n.t(strings.raw[0]);

package/package.json

@@ -0,0 +1,28 @@
+{
+	"name": "@d-zero/create-frontend",
+	"version": "5.0.0-alpha.10",
+	"description": "Create a new frontend project from a scaffolding template",
+	"repository": "https://github.com/d-zero-dev/frontend-env.git",
+	"author": "D-ZERO Co., Ltd.",
+	"license": "MIT",
+	"private": false,
+	"publishConfig": {
+		"access": "public"
+	},
+	"type": "module",
+	"bin": {
+		"create-dzero-frontend": "./index.js"
+	},
+	"dependencies": {
+		"@d-zero/scaffold": "5.0.0-alpha.10",
+		"glob": "10.4.1",
+		"i18n-js": "4.4.3",
+		"ignore": "5.3.1",
+		"meow": "13.2.0",
+		"plop": "4.0.1"
+	},
+	"devDependencies": {
+		"@types/glob": "8.1.0"
+	},
+	"gitHead": "fe914746b4a443aa95604ea28b3235d08f8ecd7f"
+}

package/plopfile.js

@@ -0,0 +1,180 @@
+import { spawn } from 'node:child_process';
+import path from 'node:path';
+
+import { globSync } from 'glob';
+import ignore from 'ignore';
+import meow from 'meow';
+
+import { t } from './locale.js';
+import { readFileSafe } from './read-file-safe.js';
+
+const cli = meow(
+	`
+	Usage
+	  $ yarn create @d-zero/frontend
+	  or
+	  $ npx @d-zero/create-frontend
+
+	Options
+	  --type, -t  Specify the type of project. Then, no interactive mode will be shown.
+	  --dir,  -d  Specify the destination directory. Default is the current directory.
+	  --install   Install dependencies with yarn after scaffolding.
+
+	Examples
+	  $ yarn create @d-zero/frontend
+	  $ yarn create @d-zero/frontend --type cms --dir ./my-cms --install
+`,
+	{
+		importMeta: import.meta,
+		flags: {
+			type: {
+				type: 'string',
+				shortFlag: 't',
+			},
+			dir: {
+				type: 'string',
+				shortFlag: 'd',
+			},
+			install: {
+				type: 'boolean',
+				default: true,
+			},
+		},
+	},
+);
+
+/**
+ * @param {import('plop').NodePlopAPI} plop
+ */
+export default function (plop) {
+	const scaffoldDir = path.normalize(
+		path.dirname(import.meta.resolve('@d-zero/scaffold').replace('file:', '')),
+	);
+
+	const gitignore = readFileSafe(path.resolve(scaffoldDir, '.gitignore'));
+	const ignoreFiles = gitignore?.split('\n').filter(Boolean) ?? [];
+
+	const ig = ignore()
+		// Ignore files in .gitignore
+		.add(ignoreFiles)
+		// Ignore test files
+		.add([
+			// Test directories
+			'**/*.test/**/*',
+		]);
+
+	const scaffoldFiles = ig.filter(
+		globSync('**/*', {
+			cwd: scaffoldDir,
+			nodir: true,
+			dot: true,
+		}),
+	);
+
+	plop.setActionType('Install dependencies', (answers) => {
+		const dest = answers['__d-zero_scaffold_dest__'] ?? cli.flags.dir ?? '.';
+		const doInstall =
+			answers['__d-zero_scaffold_yarn_install__'] ?? cli.flags.install ?? true;
+
+		const { promise, resolve, reject } = Promise.withResolvers();
+
+		if (doInstall) {
+			const child = spawn('yarn', ['install'], {
+				cwd: path.resolve(process.cwd(), dest),
+				stdio: 'inherit',
+			});
+
+			child.on('exit', (code) => {
+				if (code === 0) {
+					resolve(': success');
+				} else {
+					reject(new Error('Failed to install dependencies'));
+				}
+			});
+
+			process.on('SIGINT', () => {
+				child.kill('SIGINT');
+			});
+		} else {
+			resolve(': skipped');
+		}
+
+		return promise;
+	});
+
+	plop.setGenerator('basic', {
+		description: 'Basic scaffolding',
+		prompts: [
+			{
+				type: 'list',
+				name: '__d-zero_project_type__',
+				message: t`What's the type of project?`,
+				choices: [
+					//
+					'Static',
+					'CMS (WordPress etc.)',
+					{
+						name: 'CMS (baserCMS with BurgerEditor)',
+						value: 'burger',
+					},
+				],
+				default: cli.flags.type ?? 'burger',
+				filter: (val) => val.toLowerCase(),
+				when: !cli.flags.type,
+			},
+			{
+				type: 'input',
+				name: '__d-zero_scaffold_dest__',
+				message: t`Destination path`,
+				default: '.',
+				when: !cli.flags.type,
+			},
+			{
+				type: 'confirm',
+				name: '__d-zero_scaffold_yarn_install__',
+				message: t`Install dependencies with yarn?`,
+				default: true,
+				when: !cli.flags.type,
+			},
+		],
+		actions: function (answers) {
+			return [
+				...scaffoldFiles.map(
+					/**
+					 * @see https://plopjs.com/documentation/#add
+					 * @type {import('plop').AddActionConfig}
+					 */
+					(originFile) => {
+						const dest = answers['__d-zero_scaffold_dest__'] ?? cli.flags.dir ?? '.';
+						return {
+							type: 'add',
+							path: path.resolve(dest, originFile),
+							templateFile: path.resolve(scaffoldDir, originFile),
+							transform(content) {
+								if (originFile === 'package.json') {
+									const nameCandidate = path.basename(path.resolve(dest));
+									const pkg = JSON.parse(content);
+									pkg._createdBy = `${pkg.name}@${pkg.version}`;
+									pkg.name = nameCandidate;
+									pkg.private = true;
+									delete pkg.version;
+									delete pkg.description;
+									delete pkg.repository;
+									delete pkg.author;
+									delete pkg.license;
+									delete pkg.publishConfig;
+									delete pkg.files;
+									content = JSON.stringify(pkg, null, '\t');
+								}
+								return content;
+							},
+						};
+					},
+				),
+				{
+					type: 'Install dependencies',
+				},
+			];
+		},
+	});
+}

package/read-file-safe.js

@@ -0,0 +1,9 @@
+import fs from 'node:fs';
+
+export function readFileSafe(filePath) {
+	try {
+		return fs.readFileSync(filePath, 'utf8');
+	} catch {
+		return null;
+	}
+}