Merge pull request #2 from CrunchyData/willking/change-output

Willking/change output

.eslintrc.cjs

@@ -17,7 +17,6 @@ module.exports = {
 			},
 		],
 		'@typescript-eslint/no-unused-vars': ['warn', { varsIgnorePatter: '^_' }],
-		'no-unused-vars': ['warn', { varsIgnorePatter: '^_' }],
 		'testing-library/no-await-sync-events': 'off',
 		'jest-dom/prefer-in-document': 'off',
 		'@typescript-eslint/no-duplicate-imports': 'warn',

.gitignore

@@ -1,10 +1,10 @@
 node_modules
 
-/build
-/public/build
-/public/images
-/public/pdf
-/server-build
+/docs-build
+/docs-public/build
+/docs-public/images
+/docs-public/pdf
+/docs-server-build
 .env
 
 *.local.*
@@ -14,4 +14,4 @@ node_modules
 
 documentation
 /scripts/crd-builder/specs
-/public/documentation
+/docs-public/documentation

.prettierignore

@@ -2,9 +2,9 @@ node_modules
 
 /content/**/*.mdx
 
-/build
-/public/build
-/server-build
+/docs-build
+/docs-public/build
+/docs-server-build
 .env
 
 /test-results/

index.js → docs-index.js

@@ -1,7 +1,7 @@
 import 'dotenv/config'
 
 if (process.env.NODE_ENV === 'production') {
-	await import('./server-build/index.js')
+	await import('./docs-server-build/index.js')
 } else {
 	await import('./server/index.ts')
 }

package.json

@@ -10,11 +10,11 @@
     "build:server": "tsx ./scripts/build-server.ts",
     "dev": "run-p dev:*",
     "dev:remix": "remix dev -c \"npm run dev-server\" --no-restart",
-    "dev-server": "cross-env MOCKS=true tsx watch --clear-screen=false --ignore \"app/**\" --ignore \"build/**\" --ignore \"node_modules/**\" ./index.js",
+    "dev-server": "cross-env MOCKS=true tsx watch --clear-screen=false --ignore \"app/**\" --ignore \"docs-build/**\" --ignore \"node_modules/**\" ./index.js",
     "format": "prettier --write .",
     "lint": "eslint --cache --cache-location ./node_modules/.cache/eslint .",
     "lint:files": "ts-node --esm scripts/lint-file-case.ts",
-    "start": "cross-env NODE_ENV=production node .",
+    "start": "cross-env NODE_ENV=production node docs-index.js",
     "test": "vitest",
     "typecheck": "tsc",
     "validate": "run-p lint typecheck test",
@@ -28,10 +28,10 @@
   },
   "eslintIgnore": [
     "/node_modules",
-    "/build",
-    "/public/build",
+    "/docs-build",
+    "/docs-public/build",
     "/playwright-report",
-    "/server-build"
+    "/docs-server-build"
   ],
   "dependencies": {
     "@headlessui/react": "^1.7.14",

remix.config.js

@@ -3,6 +3,9 @@
  */
 export default {
 	cacheDirectory: './node_modules/.cache/remix',
+	assetsBuildDirectory: 'docs-public/build',
+	serverBuildPath: 'docs-build/index.js',
+	publicPath: '/docs-public/build/',
 	ignoredRouteFiles: ['**/.*', '**/.test.{js,jsx,ts,tsx}'],
 	serverModuleFormat: 'esm',
 	serverPlatform: 'node',

scripts/build-server.ts

@@ -19,7 +19,7 @@ for (const file of allFiles) {
 	if (/\.(ts|js|tsx|jsx)$/.test(file)) {
 		entries.push(file)
 	} else {
-		const dest = file.replace(here('../server'), here('../server-build'))
+		const dest = file.replace(here('../server'), here('../docs-server-build'))
 		fsExtra.ensureDirSync(path.parse(dest).dir)
 		fsExtra.copySync(file, dest)
 		console.log(`copied: ${file.replace(`${here('../server')}/`, '')}`)
@@ -32,7 +32,7 @@ console.log('building...')
 esbuild
 	.build({
 		entryPoints: glob.sync(globsafe(here('../server/**/*.+(ts|js|tsx|jsx)'))),
-		outdir: here('../server-build'),
+		outdir: here('../docs-server-build'),
 		target: [`node${pkg.engines.node}`],
 		platform: 'node',
 		format: 'esm',

server/index.ts

@@ -21,7 +21,7 @@ import {
 } from 'path-to-regexp'
 import { fileURLToPath, pathToFileURL } from 'url'
 
-const BUILD_DIR = path.join(process.cwd(), 'build', 'index.js')
+const BUILD_DIR = path.join(process.cwd(), 'docs-build', 'index.js')
 const BUILD_DIR_FILE_URL = pathToFileURL(BUILD_DIR).href
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url))
@@ -38,13 +38,13 @@ app.disable('x-powered-by')
 
 // Remix fingerprints its assets so we can cache forever.
 app.use(
-	'/build',
-	express.static('public/build', { immutable: true, maxAge: '1y' }),
+	'/docs-public/build',
+	express.static('docs-public/build', { immutable: true, maxAge: '1y' }),
 )
 
 // Everything else (like favicon.ico) is cached for an hour. You may want to be
 // more aggressive with this caching.
-app.use(express.static('public', { maxAge: '1h' }))
+app.use(express.static('docs-public', { maxAge: '1h' }))
 
 morgan.token('url', (req, res) => decodeURIComponent(req.url ?? ''))
 app.use(morgan('tiny'))