create-webpack-starter 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+## [0.2.1] - 2026-02-06
+
+### Added
+- Documentation section to README
+- Initial `docs/` directory with usage and templates overview
+
+### Changed
+- Included `docs`, `README.md`, `LICENSE`, and `CHANGELOG.md` in npm package
+
+
+## [0.2.0] - 2026-02-06
+
+### Added
+- Initial public release of `create-webpack-starter`
+- Interactive CLI for creating webpack projects
+- Support for Pug templates
+- SCSS / Less styles
+- JavaScript and TypeScript variants
+- Automatic dependency installation
+
+### Notes
+- Designed to work with `@razerspine/webpack-core`
+- Requires Node.js >= 18

package/README.md

@@ -2,6 +2,8 @@
 
 Create a modern webpack project using ready-to-use templates.
 
+---
+
 ## Usage
 
 ```bash
@@ -16,6 +18,8 @@ npx create-webpack-starter my-app \
 --no-install
 ```
 
+---
+
 ## Options
 
 | Option              | Description                     |
@@ -24,22 +28,47 @@ npx create-webpack-starter my-app \
 | `--no-install`      | Skip dependency installation    |
 | `--dry-run`         | Show what would be done         |
 
+---
+
 ## Available templates
 * pug-less-js
 * pug-less-ts
 * pug-scss-js
 * pug-scss-ts
 
+---
+
+## Documentation
+
+Detailed documentation is available in the `/docs` directory:
+
+- [Getting Started](./docs/getting-started.md)
+- [Templates](./docs/templates.md)
+- [webpack-core](./docs/webpack-core.md)
+- [FAQ](./docs/faq.md)
+
+The documentation explains:
+- how the CLI works internally
+- how templates are structured
+- design principles behind `@razerspine/webpack-core`
+- common customization patterns
+
+---
+
 ## Requirement
 * Node.js >= 18
 * npm/ pnpm/ yarn
 
+---
+
 ## How it works
 1. CLI copies the selected template
 2. Template files are written to the target directory
 3. Dependencies are installed (unless disabled)
 4. Project is ready to use
 
+---
+
 ## What you get
 - Preconfigured webpack setup
 - Pug templates
@@ -47,5 +76,7 @@ npx create-webpack-starter my-app \
 - JavaScript or TypeScript
 - Production-ready build
 
+---
+
 ## 📄 License
 This project is licensed under the ISC License.

package/docs/faq.md

@@ -0,0 +1,44 @@
+# FAQ
+
+---
+
+## Is this a replacement for Vite / CRA?
+
+No.
+
+This tool is designed for:
+- static sites
+- CMS integrations
+- full control over markup
+- Pug-based workflows
+
+---
+
+## Can I modify webpack config after creation?
+
+Yes.
+The generated project is fully editable.
+No hidden abstractions.
+
+---
+
+## Why Pug?
+
+Pug is still widely used in:
+- CMS theming
+- static site generation
+- component-based HTML workflows
+
+---
+
+## Can I add React / Vue later?
+
+Yes, but it’s not the primary goal.
+This starter focuses on template-driven projects.
+
+---
+
+## Where to report issues?
+
+GitHub:
+https://github.com/Razerspine/webpack-starter-monorepo

package/docs/getting-started.md

@@ -0,0 +1,72 @@
+# Getting Started
+
+`create-webpack-starter` is a CLI tool to quickly scaffold a modern
+webpack-based project using Pug templates and popular style/script stacks.
+
+---
+
+## Requirements
+
+- Node.js >= 18
+- npm (or pnpm / yarn)
+
+---
+
+## Create a project
+
+```bash
+npx create-webpack-starter my-app
+cd my-app
+npm run dev
+```
+#### This will:
+
+* Ask you to choose a template 
+* Copy the template files 
+* Merge dependencies 
+* Install packages 
+* Prepare a ready-to-run project
+
+---
+
+## Available scripts
+
+```bash
+npm run dev      # start webpack-dev-server
+npm run build    # production build
+npm run preview  # serve dist folder locally
+```
+
+---
+
+## Project structure (example)
+```md
+my-app/
+├── src
+│   ├── assets
+│   │   ├── fonts
+│   │   ├── i18n
+│   │   ├── icons
+│   │   ├── images
+│   │   │   ├── favicons
+│   │   ├── scripts
+│   │   │   ├── modules
+│   │   │   └── utils
+│   │   └── styles
+│   └── views
+│       ├── layout
+│       ├── mixins
+│       └── pages
+│           ├── 404
+│           └── home
+├── package.json
+└── webpack.config.js
+```
+
+---
+
+## Next steps
+
+* Customize webpack.config.js
+* Adjust aliases and paths
+* Start building pages in src/views/pages

package/docs/templates.md

@@ -0,0 +1,43 @@
+# Templates
+
+`create-webpack-starter` ships with ready-to-use templates based on real
+production setups.
+
+---
+
+## Available templates
+
+| Template        | Pug | Styles | Scripts |
+|-----------------|-----|--------|---------|
+| pug-less-js     | ✅  | Less   | JS      |
+| pug-less-ts     | ✅  | Less   | TS      |
+| pug-scss-js     | ✅  | SCSS   | JS      |
+| pug-scss-ts     | ✅  | SCSS   | TS      |
+
+---
+
+## How templates work
+
+Each template provides:
+- A complete `webpack.config.js`
+- Folder structure
+- Preconfigured loaders
+- Aliases for assets and views
+- Integration with `@razerspine/webpack-core`
+
+Templates are **copied**, not referenced — you fully own the result.
+
+---
+
+## Aliases in templates
+
+Common aliases available in Pug, JS, and styles:
+
+```text
+@views
+@styles
+@scripts
+@images
+@fonts
+@icons
+```

package/docs/webpack-core.md

@@ -0,0 +1,65 @@
+# webpack-core
+
+`@razerspine/webpack-core` is the foundation used by all templates.
+
+It provides a **stable, minimal, and production-safe webpack configuration**
+focused on template-driven builds.
+
+---
+
+## Design principles
+
+- Webpack is responsible for module resolution
+- `pug-plugin` is responsible only for templates
+- No implicit JS entry (`./src`) fallback
+- No aggressive optimizations by default
+- Aliases are resolved by webpack, not by plugins
+
+---
+
+## Responsibilities
+
+### webpack-core
+- loaders (scripts, styles, assets)
+- resolve.alias
+- environment handling
+- dev / prod separation
+
+### Templates
+- project structure
+- aliases
+- UI kit integration
+- concrete paths
+
+---
+
+## Why no splitChunks by default?
+
+During real-world testing, aggressive chunk splitting caused:
+- broken Pug asset resolution
+- unexpected entry lookups
+- unstable production builds
+
+You can still enable it manually if needed.
+
+---
+
+## Usage example
+
+```js
+const { createBaseConfig } = require('@razerspine/webpack-core');
+
+createBaseConfig({
+  mode: 'development',
+  scripts: 'js',
+  styles: 'scss',
+  templates: {
+    entry: 'src/views/pages'
+  },
+  resolve: {
+    alias: {
+      '@images': path.resolve('src/assets/images')
+    }
+  }
+});
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-webpack-starter",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Create a webpack starter with Pug, SCSS, TS and more",
   "bin": {
     "create-webpack-starter": "bin/index.js"
@@ -8,7 +8,10 @@
   "files": [
     "bin",
     "dist",
-    "README.md"
+    "docs",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
   ],
   "scripts": {
     "build": "tsc",