first commit

Author: progfay

.gitignore

@@ -0,0 +1,130 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+	"editor.defaultFormatter": "biomejs.biome",
+	"[typescript]": {
+		"editor.defaultFormatter": "biomejs.biome"
+	},
+	"editor.codeActionsOnSave": {
+		"quickfix.biome": "explicit"
+	},
+	"editor.formatOnSave": true
+}

README.md

@@ -0,0 +1,78 @@
+# `@progfay/nextjs-ssg-rewrite-rule-gen`
+
+## Description
+
+Next.js supports [Static Exports](https://nextjs.org/docs/pages/building-your-application/deploying/static-exports).
+
+However, it's a lot of work to manage the routing for the generated file without Vercel.
+[Dynamic Routes](https://nextjs.org/docs/pages/building-your-application/routing/dynamic-routes) feature makes routing more difficult.
+
+This application automatically generates [nginx rewrite rules](https://www.nginx.com/blog/creating-nginx-rewrite-rules/) for generated files.
+
+## Requirements
+
+- [Next.js](https://github.com/vercel/next.js) ([Pages Router](https://nextjs.org/docs/pages) only)
+- [nginx](https://github.com/nginx/nginx)
+
+## Installation
+
+```
+npm install -D @progfay/nextjs-ssg-rewrite-rule-gen
+```
+
+## Configuration
+
+> [!NOTE]
+> This application is available with zero configuration.
+
+You can run this application with config in following command: `nextjs-ssg-rewrite-rule-gen --config config.json`
+
+```json
+{
+	"pagesDirPath": "apps/src/pages",
+	"ignoreRoutes": ["/debug"],
+	"basePath": "/app",
+	"trailingSlash": true
+}
+```
+
+Available configs:
+- `pagesDirPath`: customize path for `pages` directory
+- `ignoreRoutes`: exclude specific paths from outputs
+- `basePath`: [next.config.js Options: basePath | Next.js](https://nextjs.org/docs/app/api-reference/next-config-js/basePath)
+- `trailingSlash`: [next.config.js Options: trailingSlash | Next.js](https://nextjs.org/docs/app/api-reference/next-config-js/trailingSlash)
+
+## How to work
+
+`pages` directory:
+```
+pages
+└── user
+    ├── [id]
+        └── index.js
+    └── new
+        └── index.js
+```
+
+↓
+
+Generated files with Static Exports (`next build` and [`output: "export"`](https://nextjs.org/docs/pages/building-your-application/deploying/static-exports#configuration)):
+```
+out
+└── user
+    ├── [id].html
+    └── new.html
+```
+
+↓
+
+nginx rewrite rules (generated by `@progfay/nextjs-ssg-rewrite-rule-gen`):
+```nginx
+location ~ ^/user/new/?$ {
+  rewrite ^/user/new/?$ /user/new.html break;
+}
+
+location ~ ^/user/[^/]+?/?$ {
+  rewrite ^/user/[^/]+?/?$ /user/[id].html break;
+}
+```

bin/nextjs-ssg-rewrite-rule-gen.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../dist/index.js')

biome.json

@@ -0,0 +1,12 @@
+{
+	"$schema": "https://biomejs.dev/schemas/1.5.0/schema.json",
+	"organizeImports": {
+		"enabled": true
+	},
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"recommended": true
+		}
+	}
+}

jest.config.js

@@ -0,0 +1,11 @@
+module.exports = {
+	testMatch: ["<rootDir>/**/*.test.ts"],
+	transform: {
+		"^.+\\.(js|jsx|ts|tsx)$": "@swc/jest",
+	},
+	transformIgnorePatterns: ["[/\\\\]node_modules[/\\\\].+\\.(js|jsx|ts|tsx)$"],
+	moduleNameMapper: {
+		"^(\\.\\.?/.*)$": ["$1.ts", "$1"],
+	},
+	moduleFileExtensions: ["ts", "js", "json"],
+};