@bariskuran/create-base 0.0.2 → 0.0.3

package/README.md

@@ -1,15 +1,9 @@
 # @bariskuran/create-base
 
-Create a project from the Base starter template:
+**An automated project setup tool for @bariskuran/base.**
 
-```sh
-npm create @bariskuran/base
-```
+## Documentation
 
-The setup asks for a workspace folder name, project name, title, description, URL, developer name, and contact details. It creates the project, installs dependencies with Yarn, and then you can start it with `yarn start`.
+For features, usage instructions, and detailed documentation, visit:
 
-You can also run the initializer directly:
-
-```sh
-npx @bariskuran/create-base
-```
+**[@bariskuran/base](https://www.npmjs.com/package/@bariskuran/base)**

package/bin/create-base.cjs

@@ -100,7 +100,15 @@ async function collectAnswers(rl) {
         "Enter developer contact information.",
     );
 
-    return { workspaceName, projectName, projectTitle, projectDescription, projectUrl, developerName, developerContact };
+    return {
+        workspaceName,
+        projectName,
+        projectTitle,
+        projectDescription,
+        projectUrl,
+        developerName,
+        developerContact,
+    };
 }
 
 function replaceEnvValue(envText, key, value) {
@@ -110,6 +118,20 @@ function replaceEnvValue(envText, key, value) {
     return envText.replace(matcher, `${key}=${encoded}`);
 }
 
+function escapeMarkdownTableCell(value) {
+    return String(value)
+        .replaceAll("&", "&")
+        .replaceAll("<", "&lt;")
+        .replaceAll(">", "&gt;")
+        .replaceAll("|", "\\|")
+        .replace(/\r?\n/g, "<br>")
+        .replaceAll("`", "\\`");
+}
+
+function escapeMarkdownHeading(value) {
+    return String(value).replace(/[\\`*_{}\[\]<>#+.!|]/g, "\\$&").replace(/\r?\n/g, " ");
+}
+
 async function writeCustomizedFiles(targetDir, answers) {
     if (!answers.skipped.has("package.json")) {
         const packagePath = path.join(targetDir, "package.json");
@@ -140,6 +162,25 @@ async function writeCustomizedFiles(targetDir, answers) {
             .replaceAll("[DEVELOPER_CONTACT]", answers.developerContact);
         await fs.promises.writeFile(licensePath, personalizedLicense);
     }
+
+    if (!answers.skipped.has("README.md")) {
+        const readmePath = path.join(targetDir, "README.md");
+        let readme = await fs.promises.readFile(readmePath, "utf8");
+        const replacements = {
+            "[PROJECT_TITLE_HEADING]": escapeMarkdownHeading(answers.projectTitle),
+            "[PROJECT_TITLE]": escapeMarkdownTableCell(answers.projectTitle),
+            "[PROJECT_DESCRIPTION]": escapeMarkdownTableCell(answers.projectDescription),
+            "[WORKSPACE_NAME]": escapeMarkdownTableCell(answers.workspaceName),
+            "[PROJECT_NAME]": escapeMarkdownTableCell(answers.projectName),
+            "[PROJECT_URL]": escapeMarkdownTableCell(answers.projectUrl),
+            "[DEVELOPER_NAME]": escapeMarkdownTableCell(answers.developerName),
+            "[DEVELOPER_CONTACT]": escapeMarkdownTableCell(answers.developerContact),
+        };
+        for (const [placeholder, value] of Object.entries(replacements)) {
+            readme = readme.replaceAll(placeholder, value);
+        }
+        await fs.promises.writeFile(readmePath, readme);
+    }
 }
 
 function promptOverwrite(relativePath) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bariskuran/create-base",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Create a project with @bariskuran/base.",
   "license": "MIT",
   "author": "Baris Kuran",

package/template/README.md

@@ -0,0 +1,46 @@
+# [PROJECT_TITLE_HEADING]
+
+> [PROJECT_DESCRIPTION]
+
+## Project details
+
+| Field | Value |
+| --- | --- |
+| Workspace folder | `[WORKSPACE_NAME]` |
+| Package name | `[PROJECT_NAME]` |
+| Project title | [PROJECT_TITLE] |
+| Project URL | `[PROJECT_URL]` |
+| Developer | [DEVELOPER_NAME] |
+| Contact | [DEVELOPER_CONTACT] |
+
+## Getting started
+
+Dependencies are installed automatically when this project is created. Start the development server with:
+
+```sh
+yarn start
+```
+
+## Available scripts
+
+| Command | Description |
+| --- | --- |
+| `yarn start` | Start with the published `@bariskuran/base` package. |
+| `yarn start:local` | Start with a local Base source checkout. |
+| `yarn build` | Build with the published `@bariskuran/base` package. |
+| `yarn build:local` | Build with a local Base source checkout. |
+| `yarn autoFill` | Generate route files from the project sitemap. |
+| `yarn images:index` | Index image catalogs under `src/imageCatalog` and `public/imageCatalog`. |
+
+## Project structure
+
+- `public/imageCatalog` — public image catalog files.
+- `src/assets` — project assets.
+- `src/functions` — project functions.
+- `src/hooks` — project hooks.
+- `src/imageCatalog` — imported image catalog files.
+- `src/views` — application pages.
+
+## License
+
+This project uses the MIT License. See [LICENSE](./LICENSE).

package/template/builder.cjs

@@ -4,7 +4,7 @@ const path = require("path");
 
 const MODE = process.argv[2]; // useGitBase | useLocalBase | buildLocal | buildRegistry
 const PKG_NAME = "@bariskuran/base";
-const BASE_SPEC = process.env.BASE_SPEC || `${PKG_NAME}@0.0.2`;
+const BASE_SPEC = process.env.BASE_SPEC || `${PKG_NAME}@0.0.3`;
 
 function run(cmd) {
     execSync(cmd, { stdio: "inherit" });

package/template/package.json

@@ -19,12 +19,11 @@
     "images:index": "node node_modules/@bariskuran/base/src/libs/createImageCatalog/tools/base-image-index.cjs"
   },
   "dependencies": {
-    "antd": "^6.3.0",
     "react": "19.2.3",
     "react-dom": "19.2.3",
     "react-router-dom": "7.12.0",
     "styled-components": "^6.3.8",
-    "@bariskuran/base": "0.0.2"
+    "@bariskuran/base": "0.0.3"
   },
   "devDependencies": {
     "@eslint/compat": "2.0.1",

package/template/src/global/PROJECT_SETTINGS.jsx

@@ -133,21 +133,6 @@ export const PROJECT_SETTINGS = {
                 secondary: "#305A7A",
             },
         },
-        makeAntdTheme: (t) => ({
-            token: {
-                colorPrimary: t.primary,
-                colorSuccess: t.success,
-                colorWarning: t.warning,
-                colorError: t.error,
-
-                colorText: t.foreground,
-                colorTextBase: t.foreground,
-
-                colorBgBase: t.background,
-                colorBgContainer: t.background,
-                colorBorder: t.grey,
-            },
-        }),
     },
 
     // BaseForm Settings