1
0
mirror of synced 2026-02-03 18:01:02 -05:00

Compare commits

...

13 Commits

Author SHA1 Message Date
beerose
d846fc6be9 Update pnpm-lock.yaml 2022-06-07 11:47:05 -07:00
github-actions[bot]
f5e80e3835 Version Packages (alpha) (#3405)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2022-06-07 11:46:31 -07:00
Aleksandra
17ce29e5e4 Update rpc plugin setup in templates (#3404) 2022-06-07 11:33:06 -07:00
Aleksandra
46d9f81adf Update templates directory for codemod (#3402) 2022-06-07 11:04:34 -07:00
Dillon Raphael
994cfc6292 pnpmlock 2022-06-07 12:09:09 -04:00
github-actions[bot]
7811748526 Version Packages (alpha) (#3401)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2022-06-07 12:08:45 -04:00
Dillon Raphael
ce45368334 Add codemods to upgrade from framework to toolkit (#3353)
* init migrate cli command

* make sure migrate command can only be run in legacy blitz directory

* extract codemods into its own package/cli

* removed unused dependencies

* renamed codemods bin directory

* update next.config file to use withBlitz

* codemods update package.json step

* codemod for blitz server & client setup, as well as the blitz rpc route in pages dir

* fix ignore previous step if statement to check for less than instead of equal

* move files from app/pages to root pages directory

* remove blitz babel plugin & update imports inside app dir

* consolidate pages from app dir to root pages dir

* move all api directories to the root pages dir

* use generator templates for blitz rpc route & server/client setup files

* update custom server file

* make custom server step work with require statement & import statements

* useRouterQuery to useRouter().query

* pkg dependecy & import map updates

* Change import map

* Add BlitzLayout to import map

* import withBlitz and wrap App function in _app

* modify _document to use next.js imports

* fix default import for next modules & add useParam to source map

* gssp/gsp

* api routes

* dont run api wrap on rpc/[[...blitz]] & error on usage of local middleware

* DRY cleanup

* update codemod steps

* add ignore extension to getAllFiles

* add more imports to source map

* check for invokeWithMiddleware

* add error counter to middleware checker

* rename codemod & fix silly typo error

* update bin file & change all invokeWithMiddleware to invoke

* add logging from blitz

* manypkg fix

* add codemod test

* lockfile

* fix test

* show errors for invokeWithMiddleware

* update invokeWithMiddleware error message

* line break in new app generator before your new blitz app is ready

* Apply suggestions from code review

* Add changeset

* changeset

* pnpmlock

Co-authored-by: beerose <alexsandra.sikora@gmail.com>
2022-06-07 12:03:37 -04:00
Dillon Raphael
4e9c1f60b6 pnpm lock 2022-06-07 11:36:45 -04:00
github-actions[bot]
508682c8f8 Version Packages (alpha) (#3400)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2022-06-07 11:35:42 -04:00
Dillon Raphael
962eb58af6 Migrate printEnvInfo to CLI (#3394)
* init printEnvInfo function

* changeset
2022-06-07 11:31:56 -04:00
Dillon Raphael
17669b3af8 pnpmlock 2022-06-07 11:06:31 -04:00
github-actions[bot]
ec6299c36a Version Packages (alpha) (#3399)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2022-06-07 11:05:15 -04:00
Dillon Raphael
6ac2d3412a Update generator template npmrc & next versions (#3398)
* add strict-peer-dependencies=false
side-effects-cache=false to npmrc generator template

* add comment to generated npmrc file

* update versions of next for full and minimal templates

* pinned next version to 12.1.6 in generator templates

* add next back to root package

* fix lock file

* add changeset

Co-authored-by: Aleksandra <alexsandra.sikora@gmail.com>
2022-06-07 10:59:28 -04:00
48 changed files with 2295 additions and 853 deletions

View File

@@ -0,0 +1,5 @@
---
"@blitzjs/generator": patch
---
updated nextjs version in generator & npmrc file

View File

@@ -0,0 +1,5 @@
---
"blitz": patch
---
detailed print env info

View File

@@ -0,0 +1,5 @@
---
"@blitzjs/codemod": patch
---
Add codemod to upgrade from legacy framework to the Blitz Toolkit

View File

@@ -12,6 +12,7 @@
"@blitzjs/rpc": "2.0.0-alpha.0",
"@blitzjs/config": "0.0.0",
"@blitzjs/generator": "2.0.0-alpha.0",
"@blitzjs/codemod": "2.0.0-alpha.0",
"template": "0.0.0",
"toolkit-app": "1.0.0",
"test-qm": "0.0.0",
@@ -25,10 +26,12 @@
"dirty-monkeys-greet",
"empty-berries-rule",
"fair-wombats-sneeze",
"famous-kings-explain",
"fast-trainers-kneel",
"flat-bees-approve",
"four-meals-fry",
"great-months-train",
"healthy-rice-shout",
"hot-drinks-approve",
"lovely-colts-share",
"modern-cameras-pull",
@@ -36,6 +39,7 @@
"nice-starfishes-live",
"nine-onions-admire",
"ninety-pets-heal",
"olive-feet-rhyme",
"plenty-bottles-swim",
"poor-peas-lick",
"poor-penguins-look",
@@ -43,16 +47,19 @@
"quiet-feet-travel",
"rich-chairs-invent",
"sharp-falcons-begin",
"shy-olives-hang",
"silent-colts-reply",
"small-socks-confess",
"stupid-walls-sell",
"swift-drinks-dress",
"tasty-news-collect",
"ten-rivers-burn",
"tender-pianos-check",
"thirty-countries-build",
"twenty-beans-pump",
"two-kiwis-help",
"unlucky-papayas-sleep",
"violet-bags-leave",
"weak-suns-shave",
"wicked-ghosts-cough",
"wise-frogs-give"

View File

@@ -0,0 +1,6 @@
---
"@blitzjs/rpc": patch
"@blitzjs/generator": patch
---
Update RPC plugin setup in templates

View File

@@ -0,0 +1,6 @@
---
"blitz": patch
"@blitzjs/codemod": patch
---
init codemod generator

View File

@@ -0,0 +1,5 @@
---
"@blitzjs/codemod": patch
---
Update templates directory for codemod

View File

@@ -7,12 +7,6 @@ export const { withBlitz } = setupBlitzClient({
AuthClientPlugin({
cookiePrefix: "web-cookie-prefix",
}),
BlitzRpcPlugin({
reactQueryOptions: {
queries: {
staleTime: 7000,
},
},
}),
BlitzRpcPlugin({}),
],
})

View File

@@ -29,7 +29,7 @@
"@blitzjs/rpc": "workspace:*",
"@hookform/resolvers": "2.8.8",
"@prisma/client": "3.9.0",
"blitz": "workspace:2.0.0-alpha.27",
"blitz": "workspace:2.0.0-alpha.31",
"next": "12.1.6-canary.17",
"prisma": "3.9.0",
"react": "18.0.0",

View File

@@ -7,13 +7,7 @@ const {withBlitz} = setupBlitzClient({
AuthClientPlugin({
cookiePrefix: "no-suspense-tests-cookie-prefix",
}),
BlitzRpcPlugin({
reactQueryOptions: {
queries: {
staleTime: 7000,
},
},
}),
BlitzRpcPlugin({}),
],
})

View File

@@ -7,13 +7,7 @@ const {withBlitz} = setupBlitzClient({
AuthClientPlugin({
cookiePrefix: "trailing-slash-tests-cookie-prefix",
}),
BlitzRpcPlugin({
reactQueryOptions: {
queries: {
staleTime: 7000,
},
},
}),
BlitzRpcPlugin({}),
],
})

View File

@@ -80,21 +80,7 @@ const BlitzWrapper = ({plugins, children}) => {
export function render(ui: RenderUI, {wrapper, router, ...options}: RenderOptions = {}) {
if (!wrapper) {
wrapper = ({children}) => {
return (
<BlitzWrapper
plugins={[
BlitzRpcPlugin({
reactQueryOptions: {
queries: {
staleTime: 7000,
},
},
}),
]}
>
{children}
</BlitzWrapper>
)
return <BlitzWrapper plugins={[BlitzRpcPlugin({})]}>{children}</BlitzWrapper>
}
}

View File

@@ -1,5 +1,31 @@
# @blitzjs/auth
## 2.0.0-alpha.31
### Patch Changes
- blitz@2.0.0-alpha.31
## 2.0.0-alpha.30
### Patch Changes
- Updated dependencies [ce453683]
- blitz@2.0.0-alpha.30
## 2.0.0-alpha.29
### Patch Changes
- Updated dependencies [962eb58a]
- blitz@2.0.0-alpha.29
## 2.0.0-alpha.28
### Patch Changes
- blitz@2.0.0-alpha.28
## 2.0.0-alpha.27
### Patch Changes

View File

@@ -1,6 +1,6 @@
{
"name": "@blitzjs/auth",
"version": "2.0.0-alpha.27",
"version": "2.0.0-alpha.31",
"scripts": {
"build": "unbuild",
"predev": "wait-on -d 250 ../blitz/dist/index-server.d.ts",
@@ -26,7 +26,7 @@
"@types/secure-password": "3.1.1",
"b64-lite": "1.4.0",
"bad-behavior": "1.0.1",
"blitz": "2.0.0-alpha.27",
"blitz": "2.0.0-alpha.31",
"cookie": "0.4.1",
"cookie-session": "2.0.0",
"debug": "4.3.3",
@@ -39,7 +39,7 @@
"url": "0.11.0"
},
"devDependencies": {
"@blitzjs/config": "workspace:2.0.0-alpha.27",
"@blitzjs/config": "workspace:2.0.0-alpha.31",
"@testing-library/react": "13.0.0",
"@testing-library/react-hooks": "7.0.2",
"@types/cookie": "0.4.1",

View File

@@ -1,5 +1,30 @@
# @blitzjs/next
## 2.0.0-alpha.31
### Patch Changes
- Updated dependencies [17ce29e5]
- @blitzjs/rpc@2.0.0-alpha.31
## 2.0.0-alpha.30
### Patch Changes
- @blitzjs/rpc@2.0.0-alpha.30
## 2.0.0-alpha.29
### Patch Changes
- @blitzjs/rpc@2.0.0-alpha.29
## 2.0.0-alpha.28
### Patch Changes
- @blitzjs/rpc@2.0.0-alpha.28
## 2.0.0-alpha.27
### Patch Changes

View File

@@ -1,6 +1,6 @@
{
"name": "@blitzjs/next",
"version": "2.0.0-alpha.27",
"version": "2.0.0-alpha.31",
"scripts": {
"build": "unbuild",
"dev": "pnpm predev && pnpm watch unbuild src --wait=0.2",
@@ -23,7 +23,7 @@
"eslint.js"
],
"dependencies": {
"@blitzjs/rpc": "2.0.0-alpha.27",
"@blitzjs/rpc": "2.0.0-alpha.31",
"@types/hoist-non-react-statics": "3.3.1",
"debug": "4.3.3",
"fs-extra": "10.0.1",
@@ -32,7 +32,7 @@
"superjson": "1.8.0"
},
"devDependencies": {
"@blitzjs/config": "workspace:2.0.0-alpha.27",
"@blitzjs/config": "workspace:2.0.0-alpha.31",
"@testing-library/dom": "8.13.0",
"@testing-library/jest-dom": "5.16.3",
"@testing-library/react": "13.0.0",
@@ -43,7 +43,7 @@
"@types/react": "18.0.1",
"@types/react-dom": "17.0.14",
"@types/testing-library__react-hooks": "4.0.0",
"blitz": "2.0.0-alpha.27",
"blitz": "2.0.0-alpha.31",
"cross-spawn": "7.0.3",
"find-up": "4.1.0",
"lodash.frompairs": "4.0.1",

View File

@@ -1,5 +1,36 @@
# @blitzjs/rpc
## 2.0.0-alpha.31
### Patch Changes
- 17ce29e5: Update RPC plugin setup in templates
- blitz@2.0.0-alpha.31
- @blitzjs/auth@2.0.0-alpha.31
## 2.0.0-alpha.30
### Patch Changes
- Updated dependencies [ce453683]
- blitz@2.0.0-alpha.30
- @blitzjs/auth@2.0.0-alpha.30
## 2.0.0-alpha.29
### Patch Changes
- Updated dependencies [962eb58a]
- blitz@2.0.0-alpha.29
- @blitzjs/auth@2.0.0-alpha.29
## 2.0.0-alpha.28
### Patch Changes
- blitz@2.0.0-alpha.28
- @blitzjs/auth@2.0.0-alpha.28
## 2.0.0-alpha.27
### Patch Changes

View File

@@ -1,6 +1,6 @@
{
"name": "@blitzjs/rpc",
"version": "2.0.0-alpha.27",
"version": "2.0.0-alpha.31",
"scripts": {
"build": "unbuild",
"predev": "wait-on -d 250 ../blitz/dist/index-server.d.ts && wait-on -d 250 ../blitz-auth/dist/index-browser.d.ts",
@@ -20,7 +20,7 @@
"dist/**"
],
"dependencies": {
"@blitzjs/auth": "2.0.0-alpha.27",
"@blitzjs/auth": "2.0.0-alpha.31",
"b64-lite": "1.4.0",
"bad-behavior": "1.0.1",
"chalk": "^4.1.0",
@@ -30,11 +30,11 @@
"zod": "3.10.1"
},
"devDependencies": {
"@blitzjs/config": "workspace:2.0.0-alpha.27",
"@blitzjs/config": "workspace:2.0.0-alpha.31",
"@types/debug": "4.1.7",
"@types/react": "18.0.1",
"@types/react-dom": "17.0.14",
"blitz": "2.0.0-alpha.27",
"blitz": "2.0.0-alpha.31",
"next": "12.1.6-canary.17",
"react": "18.0.0",
"react-dom": "18.0.0",
@@ -43,7 +43,7 @@
"watch": "1.0.2"
},
"peerDependencies": {
"blitz": "2.0.0-alpha.27",
"blitz": "2.0.0-alpha.31",
"next": "*"
},
"publishConfig": {

View File

@@ -10,8 +10,9 @@ interface BlitzRpcOptions {
reactQueryOptions?: DefaultOptions
}
export const BlitzRpcPlugin = createClientPlugin<BlitzRpcOptions, any>(
({reactQueryOptions}: BlitzRpcOptions) => {
(options?: BlitzRpcOptions) => {
const initializeQueryClient = () => {
const {reactQueryOptions} = options || {}
let suspenseEnabled = reactQueryOptions?.queries?.suspense ?? true
if (!process.env.CLI_COMMAND_CONSOLE && !process.env.CLI_COMMAND_DB) {
globalThis.__BLITZ_SUSPENSE_ENABLED = suspenseEnabled

View File

@@ -1,5 +1,33 @@
# blitz
## 2.0.0-alpha.31
### Patch Changes
- Updated dependencies [17ce29e5]
- @blitzjs/generator@2.0.0-alpha.31
## 2.0.0-alpha.30
### Patch Changes
- ce453683: init codemod generator
- @blitzjs/generator@2.0.0-alpha.30
## 2.0.0-alpha.29
### Patch Changes
- 962eb58a: detailed print env info
- @blitzjs/generator@2.0.0-alpha.29
## 2.0.0-alpha.28
### Patch Changes
- Updated dependencies [6ac2d341]
- @blitzjs/generator@2.0.0-alpha.28
## 2.0.0-alpha.27
### Patch Changes

View File

@@ -1,6 +1,6 @@
{
"name": "blitz",
"version": "2.0.0-alpha.27",
"version": "2.0.0-alpha.31",
"scripts": {
"build": "unbuild",
"dev": "watch unbuild src --wait=0.2",
@@ -23,7 +23,7 @@
"blitz": "bin/blitz"
},
"dependencies": {
"@blitzjs/generator": "2.0.0-alpha.27",
"@blitzjs/generator": "2.0.0-alpha.31",
"arg": "5.0.1",
"chalk": "^4.1.0",
"console-table-printer": "2.10.0",
@@ -32,12 +32,14 @@
"detect-port": "1.3.0",
"dotenv": "16.0.0",
"dotenv-expand": "8.0.3",
"envinfo": "7.8.1",
"esbuild": "0.14.34",
"find-up": "4.1.0",
"fs-extra": "10.0.1",
"hasbin": "1.2.3",
"npm-which": "3.0.1",
"ora": "5.3.0",
"os-name": "5.0.1",
"p-event": "4.2.0",
"pkg-dir": "5.0.0",
"prompts": "2.4.2",
@@ -50,11 +52,12 @@
"watchpack": "2.1.1"
},
"devDependencies": {
"@blitzjs/config": "workspace:2.0.0-alpha.27",
"@blitzjs/config": "workspace:2.0.0-alpha.31",
"@types/cookie": "0.4.1",
"@types/cross-spawn": "6.0.2",
"@types/debug": "4.1.7",
"@types/detect-port": "1.3.2",
"@types/envinfo": "7.8.1",
"@types/express": "4.17.13",
"@types/fs-extra": "9.0.13",
"@types/hasbin": "1.2.0",

View File

@@ -295,7 +295,7 @@ const newApp: CliCommand = async (argv) => {
postInstallSteps.push("blitz dev")
console.log("Your new Blitz app is ready! Next steps:")
console.log("\n Your new Blitz app is ready! Next steps:")
postInstallSteps.forEach((step, index) => {
console.log(chalk.yellow(` ${index + 1}. ${step}`))
})

View File

@@ -4,6 +4,10 @@ import packageJson from "../../package.json"
import {loadEnvConfig} from "../env-utils"
import {getCommandBin} from "./utils/config"
import spawn from "cross-spawn"
import {readdirSync} from "fs-extra"
import resolveFrom from "resolve-from"
import pkgDir from "pkg-dir"
import {join} from "path"
const commonArgs = {
// Types
@@ -17,6 +21,9 @@ const commonArgs = {
"-h": "--help",
"-e": "--env",
}
const args = arg(commonArgs, {
permissive: true,
})
const defaultCommand = "dev"
export type CliCommand = (argv?: string[]) => void
@@ -29,84 +36,21 @@ const commands: {[command: string]: () => Promise<CliCommand>} = {
codegen: () => import("./commands/codegen").then((i) => i.codegen),
db: () => import("./commands/db").then((i) => i.db),
}
const args = arg(commonArgs, {
permissive: true,
})
if (args["--env"]) {
process.env.APP_ENV = args["--env"]
}
loadEnvConfig(process.cwd(), undefined, {error: console.error, info: console.info})
// Version is inlined into the file using taskr build pipeline
if (args["--version"]) {
console.log(`Blitz.js v${packageJson.version}`)
process.exit(0)
}
const foundCommand = Boolean(commands[args._[0] as string])
const command = foundCommand ? (args._[0] as string) : defaultCommand
const forwardedArgs = foundCommand ? args._.slice(1) : args._
if (args["--env"]) {
process.env.APP_ENV = args["--env"]
}
const globalBlitzPath = resolveFrom(__dirname, "blitz")
const localBlitzPath = resolveFrom.silent(process.cwd(), "blitz")
if (args["--help"]) {
forwardedArgs.push("--help")
}
const isInDevelopmentAsGloballyLinked = __dirname.includes("packages/blitz/dist")
// env variable should default to dev unless the command is build or start
const defaultEnv = command === "build" || command === "start" ? "production" : "development"
const standardEnv = ["production", "development", "test"]
if (process.env.NODE_ENV && !standardEnv.includes(process.env.NODE_ENV)) {
console.warn(NON_STANDARD_NODE_ENV)
}
;(process.env as any).NODE_ENV = process.env.NODE_ENV || defaultEnv
// Make sure commands gracefully respect termination signals (e.g. from Docker)
process.on("SIGTERM", () => process.exit(0))
process.on("SIGINT", () => process.exit(0))
if (foundCommand) {
commands[command]?.()
.then((exec: any) => exec(forwardedArgs))
.then(() => {
if (command === "build") {
// ensure process exits after build completes so open handles/connections
// don't cause process to hang
process.exit(0)
}
})
.catch((err) => {
console.log(err)
})
let blitzPkgPath
if (isInDevelopmentAsGloballyLinked) {
blitzPkgPath = globalBlitzPath
} else {
if (args["--help"] && args._.length === 0) {
console.log(`
Usage
$ blitz <command>
Available commands
${Object.keys(commands).join(", ")}
Options
--env, -e App environment name
--version, -v Version number
--help, -h Displays this message
For more information run a command with the --help flag
$ blitz build --help
`)
process.exit(0)
} else {
// If the command is not found, we assume it is a command from the bin
void runCommandFromBin()
}
// localBlitzPath won't exist if used outside a blitz app directory
blitzPkgPath = localBlitzPath || globalBlitzPath
}
async function runCommandFromBin() {
@@ -125,3 +69,122 @@ async function runCommandFromBin() {
const result = spawn.sync(commandBin, process.argv.slice(3), {stdio: "inherit"})
process.exit(result.status || 0)
}
async function printEnvInfo() {
const osName = await import("os-name")
const envinfo = await import("envinfo")
const pkgManager = readdirSync(process.cwd()).includes("pnpm-lock.yaml")
? "pnpm"
: readdirSync(process.cwd()).includes("yarn-lock.yaml")
? "yarn"
: "npm"
const env = await envinfo.default.run(
{
System: ["OS", "CPU", "Memory", "Shell"],
Binaries: ["Node", "Yarn", "npm", "pnpm"],
npmPackages: [
"blitz",
"typescript",
"react",
"react-dom",
"prisma",
"@prisma/client",
"next",
],
},
{showNotFound: true},
)
const globalBlitzPkgJsonPath = pkgDir.sync(globalBlitzPath) as string
const localBlitzPkgJsonPath = pkgDir.sync(localBlitzPath)
if (globalBlitzPkgJsonPath !== localBlitzPkgJsonPath) {
// This branch won't run if user does `npx blitz` or `yarn blitz`
const globalVersion = require(join(globalBlitzPkgJsonPath, "package.json")).version
console.log(`Blitz version: ${globalVersion} (global)`)
}
if (localBlitzPkgJsonPath) {
const localVersion = require(join(localBlitzPkgJsonPath, "package.json")).version
console.log(`Blitz version: ${localVersion} (local)`)
}
console.log(
`${osName.default()} | ${process.platform}-${process.arch} | Node: ${process.version}\n`,
)
console.log(`\n Package manager: ${pkgManager}`)
console.log(env)
process.exit(0)
}
async function main() {
loadEnvConfig(process.cwd(), undefined, {error: console.error, info: console.info})
// Version is inlined into the file using taskr build pipeline
if (args["_"].length === 0 && args["--version"]) {
await printEnvInfo()
}
if (args["--env"]) {
process.env.APP_ENV = args["--env"]
}
if (args["--help"]) {
forwardedArgs.push("--help")
}
// env variable should default to dev unless the command is build or start
const defaultEnv = command === "build" || command === "start" ? "production" : "development"
const standardEnv = ["production", "development", "test"]
if (process.env.NODE_ENV && !standardEnv.includes(process.env.NODE_ENV)) {
console.warn(NON_STANDARD_NODE_ENV)
}
;(process.env as any).NODE_ENV = process.env.NODE_ENV || defaultEnv
// Make sure commands gracefully respect termination signals (e.g. from Docker)
process.on("SIGTERM", () => process.exit(0))
process.on("SIGINT", () => process.exit(0))
if (foundCommand) {
commands[command]?.()
.then((exec: any) => exec(forwardedArgs))
.then(() => {
if (command === "build") {
// ensure process exits after build completes so open handles/connections
// don't cause process to hang
process.exit(0)
}
})
.catch((err) => {
console.log(err)
})
} else {
if (args["--help"] && args._.length === 0) {
console.log(`
Usage
$ blitz <command>
Available commands
${Object.keys(commands).join(", ")}
Options
--env, -e App environment name
--version, -v Version number
--help, -h Displays this message
For more information run a command with the --help flag
$ blitz build --help
`)
process.exit(0)
} else {
// If the command is not found, we assume it is a command from the bin
void runCommandFromBin()
}
}
}
main().catch((e) => {
console.error(e)
})

View File

@@ -9,7 +9,7 @@ export * from "./types"
export * from "./prisma-utils"
export * from "./middleware"
export * from "./paginate"
export {baseLogger, newLine} from "./logging"
export {baseLogger, newLine, log} from "./logging"
export {startWatcher, stopWatcher} from "./cli/utils/routes-manifest"
// const blitzConfig = findBlitzConfigDirectory() as string
// const file = readFileSync(blitzConfig)

View File

@@ -149,6 +149,15 @@ const success = (msg: string) => {
console.log(withCheck(c.green(msg)))
}
/**
* Logs a red error message to stdout.
*
* @param {string} msg
*/
const error = (msg: string) => {
console.log(`${c.red(msg)}`)
}
/**
* Colorizes a variable for display.
*
@@ -173,6 +182,7 @@ export const log = {
progress,
spinner,
success,
error,
variable,
debug,
Table,

View File

@@ -0,0 +1 @@
module.exports = require("@blitzjs/config/eslint")

View File

@@ -0,0 +1,20 @@
# @blitzjs/codemod
## 2.0.0-alpha.31
### Patch Changes
- 46d9f81a: Update templates directory for codemod
- Updated dependencies [17ce29e5]
- @blitzjs/generator@2.0.0-alpha.31
- blitz@2.0.0-alpha.31
## 2.0.0-alpha.30
### Patch Changes
- ce453683: Add codemod to upgrade from legacy framework to the Blitz Toolkit
- ce453683: init codemod generator
- Updated dependencies [ce453683]
- blitz@2.0.0-alpha.30
- @blitzjs/generator@2.0.0-alpha.30

View File

@@ -0,0 +1,2 @@
#!/usr/bin/env node
require("@blitzjs/codemod/dist/index.cjs")

View File

@@ -0,0 +1,11 @@
import {BuildConfig} from "unbuild"
const config: BuildConfig = {
entries: ["./src/index"],
externals: ["index.cjs", "blitz"],
declaration: true,
rollup: {
emitCJS: true,
},
}
export default config

View File

@@ -0,0 +1,51 @@
{
"name": "@blitzjs/codemod",
"version": "2.0.0-alpha.31",
"scripts": {
"build": "unbuild",
"dev": "watch unbuild src --wait=0.2",
"lint": "eslint . --fix",
"test": "vitest run",
"test-watch": "vitest",
"clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist"
},
"main": "./dist/index.cjs",
"module": "./dist/index.mjs",
"browser": "./dist/index.mjs",
"types": "./dist/index.d.ts",
"sideEffects": false,
"license": "MIT",
"files": [
"dist/**",
"bin/**"
],
"bin": "bin/@blitzjs/codemod",
"dependencies": {
"@babel/core": "7.12.10",
"@babel/plugin-proposal-class-properties": "7.17.12",
"@babel/plugin-syntax-jsx": "7.17.12",
"@babel/plugin-syntax-typescript": "7.17.12",
"@blitzjs/generator": "2.0.0-alpha.31",
"arg": "5.0.1",
"blitz": "2.0.0-alpha.31",
"chalk": "^4.1.0",
"cross-spawn": "7.0.3",
"debug": "4.3.3",
"esbuild": "0.14.34",
"fs-extra": "10.0.1",
"jscodeshift": "0.13.0",
"prompts": "2.4.2"
},
"devDependencies": {
"@babel/preset-env": "7.12.10",
"@blitzjs/config": "workspace:*",
"@types/jscodeshift": "0.11.2",
"@types/node": "17.0.16",
"ast-types": "0.14.2",
"unbuild": "0.6.9",
"watch": "1.0.2"
},
"publishConfig": {
"access": "public"
}
}

View File

@@ -0,0 +1,9 @@
import {expect, describe, it} from "vitest"
import spawn from "cross-spawn"
describe("codemod cli", () => {
it("errors without codemod name", async () => {
const run = spawn.sync("node", ["dist/index.cjs"], {encoding: "utf8"})
expect(run.stdout).toContain("Codemod not found")
})
})

View File

@@ -0,0 +1,31 @@
import arg from "arg"
const commonArgs = {
// Types
"--help": Boolean,
// Aliases
"-h": "--help",
}
const args = arg(commonArgs, {
permissive: true,
})
const commands: {[command: string]: () => Promise<() => void>} = {
"upgrade-legacy": () => import("./upgrade-legacy").then((i) => i.upgradeLegacy),
}
const foundCommand = Boolean(commands[args._[0] as string])
const forwardedArgs = foundCommand ? args._.slice(1) : args._
if (foundCommand) {
commands[args["_"][0] as string]?.()
.then((exec: any) => exec(forwardedArgs))
.catch((err) => {
console.log(err)
})
} else {
console.log("Codemod not found. Try one of these:")
console.log(`${Object.keys(commands).map((c) => c)}`)
}

View File

@@ -0,0 +1,821 @@
import j, {ImportDeclaration} from "jscodeshift"
import * as fs from "fs-extra"
import path from "path"
import {
addNamedImport,
findCallExpression,
findDefaultExportPath,
findFunction,
findImport,
findVariable,
getAllFiles,
getCollectionFromSource,
wrapDeclaration,
} from "./utils"
import {log} from "blitz"
const isInternalBlitzMonorepoDevelopment = fs.existsSync(path.join(__dirname, "../../blitz-next"))
const upgradeLegacy = async () => {
let isTypescript = fs.existsSync(path.resolve("tsconfig.json"))
let blitzConfigFile = `blitz.config.${isTypescript ? "ts" : "js"}`
let isLegacyBlitz = fs.existsSync(path.resolve(blitzConfigFile))
const appDir = path.resolve("app")
let failedAt =
fs.existsSync(path.resolve(".migration.json")) && fs.readJSONSync("./.migration.json").failedAt
let steps: {
name: string
action: () => Promise<void>
}[] = []
// Add steps in order
steps.push({
name: "move the config from blitz.config.ts to next.config.js",
action: async () => {
const program = getCollectionFromSource(blitzConfigFile)
const parsedProgram = program.get()
// Clear file
parsedProgram.value.program.body = []
// We create an object property eg. {withBlitz: withBlitz}
let withBlitz = j.objectProperty(j.identifier("withBlitz"), j.identifier("withBlitz"))
// Then set the shorthand to true so we get {withBlitz}
withBlitz.shorthand = true
/* Declare the variable using the object above that equals to a require expression, eg.
const {withBlitz} = require("@blitzjs/next")
*/
let blitzDeclare = j.variableDeclaration("const", [
j.variableDeclarator(
j.objectPattern([withBlitz]),
j.callExpression(j.identifier("require"), [j.stringLiteral("@blitzjs/next")]),
),
])
parsedProgram.value.program.body.push(blitzDeclare)
// Create the module.exports with the withBlitz callExpression and empty arguments. Giving us module.exports = withBlitz()
let moduleExportExpression = j.expressionStatement(
j.assignmentExpression(
"=",
j.memberExpression(j.identifier("module"), j.identifier("exports")),
j.callExpression(j.identifier("withBlitz"), []),
),
)
parsedProgram.value.program.body.push(moduleExportExpression)
fs.writeFileSync(path.resolve("next.config.js"), program.toSource())
},
})
steps.push({
name: "update dependencies in package.json",
action: async () => {
let packageJsonPath = require(path.resolve("package.json"))
packageJsonPath.dependencies["react"] = "latest"
packageJsonPath.dependencies["react-dom"] = "latest"
packageJsonPath.dependencies["@blitzjs/next"] = "alpha"
packageJsonPath.dependencies["@blitzjs/rpc"] = "latest"
packageJsonPath.dependencies["@blitzjs/auth"] = "latest"
packageJsonPath.dependencies["blitz"] = "alpha"
packageJsonPath.dependencies["next"] = "latest"
packageJsonPath.dependencies["prisma"] = "latest"
packageJsonPath.dependencies["@prisma/client"] = "latest"
packageJsonPath.devDependencies["typescript"] = isTypescript && "latest"
fs.writeFileSync(path.resolve("package.json"), JSON.stringify(packageJsonPath, null, " "))
},
})
steps.push({
name: "update project's imports",
action: async () => {
const specialImports: Record<string, string> = {
Link: "next/link",
Image: "next/image",
Script: "next/script",
Document: "next/document",
DocumentHead: "next/document",
Html: "next/document",
Main: "next/document",
BlitzScript: "next/document",
AuthenticationError: "blitz",
AuthorizationError: "blitz",
CSRFTokenMismatchError: "blitz",
NotFoundError: "blitz",
formatZodError: "blitz",
recursiveFormatZodErrors: "blitz",
validateZodSchema: "blitz",
enhancePrisma: "blitz",
ErrorBoundary: "@blitzjs/next",
ErrorFallbackProps: "@blitzjs/next",
paginate: "blitz",
invokeWithMiddleware: "@blitzjs/rpc",
passportAuth: "@blitzjs/auth",
sessionMiddleware: "@blitzjs/auth",
simpleRolesIsAuthorized: "@blitzjs/auth",
getSession: "@blitzjs/auth",
setPublicDataForUser: "@blitzjs/auth",
SecurePassword: "@blitzjs/auth",
hash256: "@blitzjs/auth",
generateToken: "@blitzjs/auth",
resolver: "@blitzjs/rpc",
connectMiddleware: "blitz",
GetServerSideProps: "next",
InferGetServerSidePropsType: "next",
GetServerSidePropsContext: "next",
getAntiCSRFToken: "@blitzjs/rpc",
useSession: "@blitzjs/auth",
useAuthenticatedSession: "@blitzjs/auth",
useRedirectAuthenticated: "@blitzjs/auth",
useAuthorize: "@blitzjs/auth",
useQuery: "@blitzjs/rpc",
useParam: "@blitzjs/next",
usePaginatedQuery: "@blitzjs/rpc",
useInfiniteQuery: "@blitzjs/rpc",
useMutation: "@blitzjs/rpc",
queryClient: "@blitzjs/rpc",
getQueryKey: "@blitzjs/rpc",
getInfiniteQueryKey: "@blitzjs/rpc",
invalidateQuery: "@blitzjs/rpc",
setQueryData: "@blitzjs/rpc",
useQueryErrorResetBoundary: "@blitzjs/rpc",
QueryClient: "@blitzjs/rpc",
dehydrate: "@blitzjs/rpc",
invoke: "@blitzjs/rpc",
Routes: "@blitzjs/next",
useRouterQuery: "next/router",
useRouter: "next/router",
Router: "next/router",
Head: "next/head",
App: "next/app",
dynamic: "next/dynamic",
noSSR: "next/dynamic",
getConfig: "next/config",
setConfig: "next/config",
ErrorComponent: "@blitzjs/next",
AppProps: "@blitzjs/next",
BlitzPage: "@blitzjs/next",
BlitzLayout: "@blitzjs/next",
}
getAllFiles(appDir, [], [], [".css"]).forEach((filename) => {
const program = getCollectionFromSource(path.resolve(appDir, filename))
const parsedProgram = program.get()
parsedProgram.value.program.body.forEach((e: ImportDeclaration) => {
if (e.type === "ImportDeclaration") {
if (e.source.value === "blitz") {
const specifierIndexesToRemove: number[] = []
e.specifiers?.slice().forEach((specifier: any, index) => {
const importedName =
specifier.imported.type === "StringLiteral"
? specifier.imported.value
: specifier.imported.name
if (importedName in specialImports) {
parsedProgram.value.program.body.unshift(
j.importDeclaration(
[specifier],
j.stringLiteral(specialImports[importedName] as string),
),
)
specifierIndexesToRemove.push(index)
}
})
// Remove import from original blitz import deconstruct
specifierIndexesToRemove.reverse().forEach((index) => {
e.specifiers?.splice(index, 1)
})
// Removed left over "import 'blitz';"
if (!e.specifiers?.length) {
const index = parsedProgram.value.program.body.indexOf(e)
parsedProgram.value.program.body.splice(index, 1)
}
}
}
})
fs.writeFileSync(path.resolve(appDir, filename), program.toSource())
})
},
})
steps.push({
name: "update NextJS' default imports",
action: async () => {
getAllFiles(appDir, [], [], [".css"]).forEach((file) => {
const program = getCollectionFromSource(file)
const nextImage = findImport(program, "next/image")
const nextLink = findImport(program, "next/link")
const nextHead = findImport(program, "next/head")
if (nextImage?.length) {
nextImage.remove()
program
.get()
.value.program.body.unshift(
j.importDeclaration(
[j.importDefaultSpecifier(j.identifier("Image"))],
j.stringLiteral("next/image"),
),
)
}
if (nextLink?.length) {
nextLink.remove()
program
.get()
.value.program.body.unshift(
j.importDeclaration(
[j.importDefaultSpecifier(j.identifier("Link"))],
j.stringLiteral("next/link"),
),
)
}
if (nextHead?.length) {
nextHead.remove()
program
.get()
.value.program.body.unshift(
j.importDeclaration(
[j.importDefaultSpecifier(j.identifier("Head"))],
j.stringLiteral("next/head"),
),
)
}
fs.writeFileSync(path.join(path.resolve(file)), program.toSource())
})
},
})
steps.push({
name: "create blitz-server.ts and blitz-client.ts setup files",
action: async () => {
let appDirExist = fs.existsSync(appDir)
if (appDirExist) {
const templatePath = path.join(
require.resolve("@blitzjs/generator"),
"..",
"..",
isInternalBlitzMonorepoDevelopment ? "templates" : "dist/templates",
)
const blitzServer = fs
.readFileSync(path.join(templatePath, "app", "app", "blitz-server.ts"))
.toString()
const blitzClient = fs
.readFileSync(path.join(templatePath, "app", "app", "blitz-client.ts"))
.toString()
const replaceTemplateValues = (input: string) => {
let result = input
const token = `__safeNameSlug__`
if (result.includes(token)) {
result = result.replace(new RegExp(token, "g"), "blitz")
}
return result
}
fs.writeFileSync(
`${appDir}/blitz-server.${isTypescript ? "ts" : "js"}`,
replaceTemplateValues(blitzServer),
)
fs.writeFileSync(
`${appDir}/blitz-client.${isTypescript ? "ts" : "js"}`,
replaceTemplateValues(blitzClient),
)
} else {
throw new Error("App directory doesn't exit")
}
},
})
steps.push({
name: "create pages/api/rpc directory and add [[...blitz]].ts wildecard API route",
action: async () => {
const pagesDir = path.resolve("pages/api/rpc")
const templatePath = path.join(require.resolve("@blitzjs/generator"), "..", "..", "templates")
const rpcRoute = fs
.readFileSync(path.join(templatePath, "app", "pages", "api", "rpc", "blitzrpcroute.ts"))
.toString()
if (!fs.existsSync(pagesDir)) {
fs.mkdirSync(pagesDir, {recursive: true})
}
fs.writeFileSync(
path.resolve(`${pagesDir}/[[...blitz]].${isTypescript ? "ts" : "js"}`),
rpcRoute,
)
},
})
steps.push({
name: "move app/pages/ to the project root pages/ directory",
action: async () => {
const appDir = path.resolve("app")
const subdirs = fs.readdirSync(appDir)
if (subdirs.includes("pages")) {
const appPagesDir = fs.readdirSync(path.join(appDir, "pages"))
appPagesDir.forEach((dir) => {
fs.moveSync(
path.resolve(path.join(appDir, "pages", dir)),
path.resolve(path.join("pages", dir)),
)
})
}
// Remove pages dir from the app dir after move is complete
fs.removeSync(path.join(appDir, "pages"))
},
})
steps.push({
name: "remove Babel config file",
action: async () => {
const babelConfig = fs.existsSync(path.resolve("babel.config.js"))
if (babelConfig) {
fs.removeSync(path.resolve("babel.config.js"))
}
},
})
steps.push({
name: "move all pages directories to one consolidated directory",
action: async () => {
const getAllPagesDirs = (dirPath: string) => {
let files = fs.readdirSync(dirPath)
const pageDir = files.reduce((arr: {model: string; path: string}[], file: string) => {
if (fs.statSync(dirPath + "/" + file).isDirectory()) {
let subs = fs.readdirSync(dirPath + "/" + file)
if (subs.includes("pages")) {
arr.push({
model: file,
path: dirPath + "/" + file + "/pages",
})
}
}
return arr
}, [])
return pageDir
}
getAllPagesDirs(appDir).forEach((pages) => {
fs.moveSync(pages.path, path.join(path.resolve("pages"), pages.model))
})
},
})
steps.push({
name: "move API routes to pages/api directory",
action: async () => {
const apiRoutesExist = fs.existsSync(path.join(appDir, "api"))
if (apiRoutesExist) {
let apiRoutes = fs.readdirSync(path.join(appDir, "api"))
apiRoutes.forEach((dir) => {
if (fs.statSync(appDir + "/api/" + dir).isDirectory()) {
fs.moveSync(appDir + "/api/" + dir, path.join(path.resolve("pages"), "api", dir))
}
})
}
},
})
steps.push({
name: "update custom server to reference Next",
action: async () => {
const customServerDir = path.resolve("server")
const customServerFile = path.resolve(`server.${isTypescript ? "ts" : "js"}`)
// If custom server is inside "server" dir
if (fs.existsSync(customServerDir)) {
if (fs.readdirSync("server").includes(`index.${isTypescript ? "ts" : "js"}`)) {
const program = getCollectionFromSource(
path.join("server", `index.${isTypescript ? "ts" : "js"}`),
)
const findBlitzCall = program.find(
j.Identifier,
(node) => node.name === "blitz" || node.escapedText === "blitz",
)
const findBlitzCustomServerLiteral = program
.find(j.StringLiteral, (node) => node.value === "blitz/custom-server")
.get()
findBlitzCustomServerLiteral.value.value = "next"
findBlitzCall.forEach((hit) => {
// Loops through the blitz calls. Check if its a call expression, require statement or import statement. Will check everything to next instead of blitz
switch (hit.name) {
case "callee":
hit.value.name = "next"
case "id":
hit.value.name = "next"
case "local":
hit.value.name = "next"
}
})
fs.writeFileSync(
path.join("server", `index.${isTypescript ? "ts" : "js"}`),
program.toSource(),
)
}
}
// If custom server file found outside dir
if (fs.existsSync(customServerFile)) {
const program = getCollectionFromSource(customServerFile)
const findBlitzCall = program.find(
j.Identifier,
(node) => node.name === "blitz" || node.escapedText === "blitz",
)
const findBlitzCustomServerLiteral = program
.find(j.StringLiteral, (node) => node.value === "blitz/custom-server")
.get()
findBlitzCustomServerLiteral.value.value = "next"
findBlitzCall.forEach((hit) => {
// Loops through the blitz calls. Check if its a call expression, require statement or import statement. Will check everything to next instead of blitz
switch (hit.name) {
case "callee":
hit.value.name = "next"
case "id":
hit.value.name = "next"
case "local":
hit.value.name = "next"
}
})
fs.writeFileSync(customServerFile, program.toSource())
}
},
})
steps.push({
name: "convert useRouterQuery to useRouter",
action: async () => {
//First check ./pages
const pagesDir = path.resolve("pages")
getAllFiles(pagesDir, [], [], [".css"]).forEach((file) => {
const filepath = path.resolve(pagesDir, file)
const program = getCollectionFromSource(filepath)
const parsedProgram = program.get()
const findRouterQueryImport = findImport(program, "next/router")
findRouterQueryImport?.forEach((node) => {
const getNode = node.get()
getNode.value.specifiers.slice().forEach((specifier: any, index: number) => {
const importedName =
specifier.imported.type === "StringLiteral"
? specifier.imported.value
: specifier.imported.name
if (importedName === "useRouterQuery") {
addNamedImport(program, "useRouter", "next/router")
getNode.value.specifiers.splice(index, 1)
// Removed left overs
if (!getNode.value.specifiers?.length) {
const index = parsedProgram.value.program.body.indexOf(getNode.value)
parsedProgram.value.program.body.splice(index, 1)
}
}
})
})
const findCallUseRouterQuery = program.find(
j.CallExpression,
(node) => node.callee.name === "useRouterQuery",
)
findCallUseRouterQuery.forEach((call) => {
const nodePath = call.get()
nodePath.parentPath.value.init = j.expressionStatement(
j.memberExpression(
j.callExpression(j.identifier("useRouter"), []),
j.identifier("query"),
),
)
})
fs.writeFileSync(filepath, program.toSource())
})
getAllFiles(appDir, [], [], [".css"]).forEach((file) => {
const filepath = path.resolve(appDir, file)
const program = getCollectionFromSource(filepath)
const parsedProgram = program.get()
const findRouterQueryImport = program.find(
j.ImportDeclaration,
(node) => node.source.value === "next/router",
)
findRouterQueryImport.forEach((node) => {
const getNode = node.get()
getNode.value.specifiers.slice().forEach((specifier: any, index: number) => {
const importedName =
specifier.imported.type === "StringLiteral"
? specifier.imported.value
: specifier.imported.name
if (importedName === "useRouterQuery") {
parsedProgram.value.program.body.unshift(
j.importDeclaration(
[j.importSpecifier(j.identifier("useRouter"))],
j.stringLiteral("next/router"),
),
)
getNode.value.specifiers.splice(index, 1)
// Removed left overs
if (!getNode.value.specifiers?.length) {
const index = parsedProgram.value.program.body.indexOf(getNode.value)
parsedProgram.value.program.body.splice(index, 1)
}
}
})
})
const findCallUseRouterQuery = program.find(
j.CallExpression,
(node) => node.callee.name === "useRouterQuery",
)
findCallUseRouterQuery.forEach((call) => {
const nodePath = call.get()
nodePath.parentPath.value.init = j.expressionStatement(
j.memberExpression(
j.callExpression(j.identifier("useRouter"), []),
j.identifier("query"),
),
)
})
fs.writeFileSync(filepath, program.toSource())
})
},
})
steps.push({
name: "wrap App component with withBlitz HOC",
action: async () => {
const pagesDir = path.resolve("pages")
const program = getCollectionFromSource(
path.join(pagesDir, `_app.${isTypescript ? "tsx" : "jsx"}`),
)
const appFunction = program.find(j.FunctionDeclaration, (node) => {
return node.id.name === "App"
})
// Store the App function
const storeFunction = {...appFunction.get().value}
// Create a new withBlitz call expresion with an empty argument
const withBlitzFunction = (appFunction.get().parentPath.value.declaration =
j.expressionStatement(j.callExpression(j.identifier("withBlitz"), []))) as any
// Push stored function above into the argument
withBlitzFunction.expression.arguments.push(storeFunction)
addNamedImport(program, "withBlitz", "app/blitz-client")
fs.writeFileSync(
path.join(pagesDir, `_app.${isTypescript ? "tsx" : "jsx"}`),
program.toSource(),
)
},
})
steps.push({
name: "update imports in the _document file",
action: async () => {
const pagesDir = path.resolve("pages")
if (fs.existsSync(path.join(pagesDir, `_document.${isTypescript ? "tsx" : "jsx"}`))) {
const program = getCollectionFromSource(
path.join(pagesDir, `_document.${isTypescript ? "tsx" : "jsx"}`),
)
const importStatements = findImport(program, "next/document")
importStatements?.remove()
program
.get()
.value.program.body.unshift(
j.importDeclaration(
[
j.importDefaultSpecifier(j.identifier("Document")),
j.importSpecifier(j.identifier("Html")),
j.importSpecifier(j.identifier("Head")),
j.importSpecifier(j.identifier("Main")),
j.importSpecifier(j.identifier("NextScript")),
],
j.stringLiteral("next/document"),
),
)
const documentHead = program
.find(j.Identifier, (node) => node.name === "DocumentHead")
.get()
documentHead.value.name = "Head"
const blitzScript = program.find(j.Identifier, (node) => node.name === "BlitzScript").get()
blitzScript.value.name = "NextScript"
fs.writeFileSync(
path.join(pagesDir, `_document.${isTypescript ? "tsx" : "jsx"}`),
program.toSource(),
)
}
},
})
steps.push({
name: "wrap getServerSideProps, getStaticProps and API handlers with gSSP, gSP, and api",
action: async () => {
const pagesDir = path.resolve("pages")
getAllFiles(pagesDir, [], ["api"]).forEach((file) => {
const program = getCollectionFromSource(file)
// 1. getServerSideProps
const getServerSidePropsPath = findFunction(program, "getServerSideProps")
if (getServerSidePropsPath) {
getServerSidePropsPath.forEach((path) =>
wrapDeclaration(path, "getServerSideProps", "gSSP"),
)
addNamedImport(program, "gSSP", "app/blitz-server")
}
// 2. getStaticProps
const getStaticPropsPath = findFunction(program, "getStaticProps")
if (getStaticPropsPath) {
getStaticPropsPath.forEach((path) => wrapDeclaration(path, "getStaticProps", "gSP"))
addNamedImport(program, "gSP", "app/blitz-server")
}
fs.writeFileSync(path.join(path.resolve(file)), program.toSource())
})
// 3. api
if (fs.existsSync(path.join(pagesDir, "api"))) {
getAllFiles(path.join(pagesDir, "api"), [], ["rpc"]).forEach((file) => {
const program = getCollectionFromSource(file)
const defaultExportPath = findDefaultExportPath(program)
if (!defaultExportPath) {
return
}
const {node} = defaultExportPath
node.declaration = j.callExpression(j.identifier("api"), [node.declaration as any])
addNamedImport(program, "api", "app/blitz-server")
fs.writeFileSync(path.join(path.resolve(file)), program.toSource())
})
}
},
})
steps.push({
name: "check for usages of a local middleware in resolvers files",
action: async () => {
let errors = 0
getAllFiles(appDir, [], ["components"], [".css"]).forEach((file) => {
const program = getCollectionFromSource(file)
const middlewarePath = findVariable(program, "middleware")
if (middlewarePath?.length) {
console.error(`Local middleware found at ${file}`)
errors++
}
})
if (errors > 0) {
throw new Error("Local middleware is not supported")
}
},
})
steps.push({
name: "check for usages of invokeWithMiddleware",
action: async () => {
let errors = 0
getAllFiles(appDir, [], [], [".css"]).forEach((file) => {
const program = getCollectionFromSource(file)
const invokeWithMiddlewarePath = findCallExpression(program, "invokeWithMiddleware")
if (invokeWithMiddlewarePath?.length) {
console.error(`invokeWithMiddleware found at ${file}.`)
errors++
}
})
getAllFiles(path.resolve("pages"), [], [], [".css"]).forEach((file) => {
const program = getCollectionFromSource(file)
const invokeWithMiddlewarePath = findCallExpression(program, "invokeWithMiddleware")
if (invokeWithMiddlewarePath?.length) {
console.error(`invokeWithMiddleware found at ${file}.`)
errors++
}
})
if (errors > 0) {
throw new Error(
"invokeWithMiddleware is not supported. Use invokeWithCtx instead: https://canary.blitzjs.com/docs/resolver-server-utilities#invoke-with-ctx",
)
}
},
})
// steps.push({
// name: "Update invokeMiddleware to invoke",
// action: async () => {
// getAllFiles(appDir, [], [], [".css"]).forEach((file) => {
// const program = getCollectionFromSource(file)
// const importSpecifier = findImportSpecifier(program, "invokeWithMiddleware")
// importSpecifier?.paths().forEach((path) => {
// path.get().value.imported.name = "invoke"
// })
// const invokeWithMiddlewarePath = findCallExpression(program, "invokeWithMiddleware")
// if (invokeWithMiddlewarePath?.length) {
// invokeWithMiddlewarePath?.paths().forEach((path) => {
// path.get().value.callee.name = "invoke"
// if (path.get().value.arguments.length === 3) {
// delete path.get().value.arguments[2]
// }
// })
// }
// fs.writeFileSync(path.resolve(file), program.toSource())
// })
// getAllFiles(path.resolve("pages"), [], [], [".css"]).forEach((file) => {
// const program = getCollectionFromSource(file)
// const importSpecifier = findImportSpecifier(program, "invokeWithMiddleware")
// importSpecifier?.paths().forEach((path) => {
// path.get().value.imported.name = "invoke"
// })
// const invokeWithMiddlewarePath = findCallExpression(program, "invokeWithMiddleware")
// if (invokeWithMiddlewarePath?.length) {
// invokeWithMiddlewarePath?.paths().forEach((path) => {
// path.get().value.callee.name = "invoke"
// if (path.get().value.arguments.length === 3) {
// delete path.get().value.arguments[2]
// }
// })
// }
// fs.writeFileSync(path.resolve(file), program.toSource())
// })
// },
// })
// Loop through steps and run the action
if ((failedAt && failedAt < steps.length) || failedAt !== "SUCCESS" || isLegacyBlitz) {
for (let [index, step] of steps.entries()) {
// Ignore previous steps and continue at step that was failed
if (failedAt && index + 1 < failedAt) {
continue
}
const spinner = log.spinner(log.withBrand(`Running ${step.name}...`)).start()
try {
await step.action()
} catch (err) {
spinner.fail(`${step.name}`)
log.error(err as string)
failedAt = index + 1
fs.writeJsonSync(".migration.json", {
failedAt,
})
process.exit(1)
}
spinner.succeed(`Successfully ran ${step.name}`)
}
fs.writeJsonSync(".migration.json", {
failedAt: "SUCCESS",
})
} else {
if (failedAt === "SUCCESS") {
log.withBrand("Migration already successful")
process.exit(0)
}
log.error("Legacy blitz config file not found")
}
}
export {upgradeLegacy}

View File

@@ -0,0 +1,234 @@
import path from "path"
import * as fs from "fs-extra"
import j, {
ASTPath,
Collection,
FunctionDeclaration,
VariableDeclaration,
ExportDefaultDeclaration,
ImportDeclaration,
CallExpression,
ImportSpecifier,
} from "jscodeshift"
import {parseSync} from "@babel/core"
export function findFunction(
program: Collection<any>,
declarationName: string,
): Collection<FunctionDeclaration> | Collection<VariableDeclaration> | null {
const funcDeclaration = program.find(
j.FunctionDeclaration,
(node) => node.id.name === declarationName,
)
const constDeclaration = program.find(
j.VariableDeclaration,
(node) => node.declarations[0].id.name === declarationName,
)
const paths = funcDeclaration.length
? funcDeclaration
: constDeclaration.length
? constDeclaration
: null
return paths
}
export function findVariable(
program: Collection<any>,
declarationName: string,
): Collection<VariableDeclaration> | null {
const constDeclaration = program.find(
j.VariableDeclaration,
(node) => node.declarations[0].id.name === declarationName,
)
const paths = constDeclaration.length ? constDeclaration : null
return paths
}
export function findImport(
program: Collection<any>,
declarationName: string,
): Collection<ImportDeclaration> | null {
const importDeclaration = program.find(
j.ImportDeclaration,
(node) => node.source.value === declarationName,
)
const paths = importDeclaration.length ? importDeclaration : null
return paths
}
export function findImportSpecifier(
program: Collection<any>,
declarationName: string,
): Collection<ImportSpecifier> | null {
const importSpecifier = program.find(
j.ImportSpecifier,
(node) => node.imported.name === declarationName,
)
const paths = importSpecifier.length ? importSpecifier : null
return paths
}
export function findCallExpression(
program: Collection<any>,
declarationName: string,
): Collection<CallExpression> | null {
const callExpression = program.find(
j.CallExpression,
(node) => node.callee.name === declarationName,
)
const paths = callExpression.length ? callExpression : null
return paths
}
export function findDefaultExportPath(
program: Collection<any>,
): ASTPath<ExportDefaultDeclaration> | null | undefined {
const defaultDeclaration = program.find(j.ExportDefaultDeclaration)
return defaultDeclaration.length ? defaultDeclaration.paths()[0] : null
}
export function wrapDeclaration(
path: ASTPath<FunctionDeclaration> | ASTPath<VariableDeclaration>,
declaration: string,
wrapper: string,
) {
if (path.node.type === "FunctionDeclaration") {
// CASE 1
// function myFunction()
// TURNS INTO
// const myFunction = wrapper(function myFunction () {})
path.replace(
j.variableDeclaration("const", [
j.variableDeclarator(
j.identifier(declaration),
j.callExpression(j.identifier(wrapper), [
j.functionExpression.from({
id: path.node.id,
async: path.node.async,
body: path.node.body,
params: path.node.params,
typeParameters: path.node.typeParameters,
defaults: path.node.defaults,
expression: path.node.expression,
generator: path.node.generator,
returnType: path.node.returnType,
rest: path.node.rest,
comments: path.node.comments ?? null,
}),
]),
),
]),
)
} else if (path.node.type === "VariableDeclaration") {
// CASE 2
// const myFunction = () => {}
// TURNS INTO
// const myFunction = gSSP(() => {})
for (const declaration of path.node.declarations) {
if (declaration.type === "VariableDeclarator" && declaration.init) {
const init = declaration.init
// Running the codemod twice should not wrap in `gSSP` twice.
if (
init.type === "CallExpression" &&
init.callee.type === "Identifier" &&
init.callee.name === wrapper
) {
// For 100% confidence, we could probably check if gSSP is imported from Blitz here
// but this codemod adds the gSSP import.
continue
}
declaration.init = j.callExpression(j.identifier(wrapper), [init])
break
}
}
}
}
export function addNamedImport(
program: Collection<any>,
importStatement: string,
importFrom: string,
defaultSpecifier?: boolean,
) {
const existingImport = program.find(
j.ImportDeclaration,
(node) => node.source.value === importFrom,
)
if (existingImport.length) {
existingImport.get().value.specifiers.push(j.importSpecifier(j.identifier(importStatement)))
} else {
program
.get()
.value.program.body.unshift(
defaultSpecifier
? j.importDeclaration(
[j.importDefaultSpecifier(j.identifier(importStatement))],
j.stringLiteral(importFrom),
)
: j.importDeclaration(
[j.importSpecifier(j.identifier(importStatement))],
j.stringLiteral(importFrom),
),
)
}
}
export function getAllFiles(
dirPath: string,
accFiles: string[] = [],
skipDirs?: string[],
skipExt?: string[],
) {
let currentFiles = fs.readdirSync(dirPath)
currentFiles.forEach((file) => {
if (fs.statSync(dirPath + "/" + file).isDirectory()) {
if (!skipDirs?.includes(file)) {
accFiles = getAllFiles(dirPath + "/" + file, accFiles, skipDirs, skipExt)
}
} else {
if (!skipExt?.includes(path.extname(file))) {
accFiles.push(path.join(dirPath, "/", file))
}
}
})
return accFiles
}
export function getCollectionFromSource(filename: string) {
const fileSource = fs.readFileSync(path.resolve(filename), {encoding: "utf-8"})
return j(fileSource, {
parser: {
parse: (source: string) =>
parseSync(source, {
configFile: false,
plugins: [require(`@babel/plugin-syntax-jsx`)],
overrides: [
{
test: [`**/*.ts`, `**/*.tsx`],
plugins: [[require(`@babel/plugin-syntax-typescript`), {isTSX: true}]],
},
],
filename,
parserOpts: {
tokens: true, // recast uses this
},
}),
},
})
}

View File

@@ -0,0 +1,10 @@
{
"extends": "@blitzjs/config/tsconfig.library.json",
"compilerOptions": {
"lib": ["DOM", "ES2015"],
"esModuleInterop": true,
"resolveJsonModule": true
},
"include": ["."],
"exclude": ["dist", "build", "node_modules"]
}

View File

@@ -1,5 +1,13 @@
# @blitzjs/config
## 2.0.0-alpha.31
## 2.0.0-alpha.30
## 2.0.0-alpha.29
## 2.0.0-alpha.28
## 2.0.0-alpha.27
## 2.0.0-alpha.26

View File

@@ -1,7 +1,7 @@
{
"name": "@blitzjs/config",
"private": true,
"version": "2.0.0-alpha.27",
"version": "2.0.0-alpha.31",
"license": "MIT",
"dependencies": {
"@typescript-eslint/eslint-plugin": "5.9.1",

View File

@@ -1,5 +1,21 @@
# @blitzjs/generator
## 2.0.0-alpha.31
### Patch Changes
- 17ce29e5: Update RPC plugin setup in templates
## 2.0.0-alpha.30
## 2.0.0-alpha.29
## 2.0.0-alpha.28
### Patch Changes
- 6ac2d341: updated nextjs version in generator & npmrc file
## 2.0.0-alpha.27
## 2.0.0-alpha.26

View File

@@ -1,6 +1,6 @@
{
"name": "@blitzjs/generator",
"version": "2.0.0-alpha.27",
"version": "2.0.0-alpha.31",
"scripts": {
"dev": "watch unbuild src --wait=0.2",
"build": "unbuild && pnpm build:templates",
@@ -45,7 +45,7 @@
"vinyl": "2.2.1"
},
"devDependencies": {
"@blitzjs/config": "2.0.0-alpha.27",
"@blitzjs/config": "2.0.0-alpha.31",
"@juanm04/cpx": "2.0.1",
"@types/babel__core": "7.1.19",
"@types/diff": "5.0.2",

View File

@@ -7,12 +7,6 @@ export const { withBlitz } = setupBlitzClient({
AuthClientPlugin({
cookiePrefix: "__safeNameSlug__-cookie-prefix",
}),
BlitzRpcPlugin({
reactQueryOptions: {
queries: {
staleTime: 7000,
},
},
}),
BlitzRpcPlugin({}),
],
})

View File

@@ -1,7 +1,9 @@
save-exact=true
legacy-peer-deps=true
strict-peer-dependencies=false
side-effects-cache=false
public-hoist-pattern[]=next
public-hoist-pattern[]=secure-password
public-hoist-pattern[]=*jest*
public-hoist-pattern[]=@testing-library/*
# Needed for Blitz to work properly. Don't remove the lines above.

View File

@@ -27,7 +27,7 @@
"@blitzjs/rpc": "latest",
"@prisma/client": "3.9.0",
"blitz": "alpha",
"next": "12.1.1",
"next": "12.1.6",
"prisma": "3.9.0",
"react": "18.0.0",
"react-dom": "18.0.0",

View File

@@ -27,7 +27,7 @@
"@blitzjs/rpc": "latest",
"@prisma/client": "3.9.0",
"blitz": "alpha",
"next": "12.1.1",
"next": "12.1.6",
"prisma": "3.9.0",
"react": "18.0.0",
"react-dom": "18.0.0",

View File

@@ -1,7 +1,9 @@
save-exact=true
legacy-peer-deps=true
strict-peer-dependencies=false
side-effects-cache=false
public-hoist-pattern[]=next
public-hoist-pattern[]=secure-password
public-hoist-pattern[]=*jest*
public-hoist-pattern[]=@testing-library/*
# Needed for Blitz to work properly. Don't remove the lines above.

View File

@@ -20,7 +20,7 @@
"dependencies": {
"@blitzjs/next": "alpha",
"blitz": "alpha",
"next": "12.1.1",
"next": "12.1.6",
"react": "18.0.0",
"react-dom": "18.0.0",
"ts-node": "10.7.0"

View File

@@ -22,7 +22,7 @@
"dependencies": {
"@blitzjs/next": "alpha",
"blitz": "alpha",
"next": "12.1.1",
"next": "12.1.6",
"react": "18.0.0",
"react-dom": "18.0.0",
"ts-node": "10.7.0"

View File

@@ -25,7 +25,7 @@
"@typescript-eslint/parser": "5.9.1"
},
"devDependencies": {
"@blitzjs/config": "2.0.0-alpha.27",
"@blitzjs/config": "2.0.0-alpha.31",
"@types/react": "18.0.1",
"@types/react-dom": "17.0.14",
"react": "18.0.0",

1456
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff