feat: refactor, wip scaffolding

Author: balazsorban44

commands/init.js

@@ -4,8 +4,10 @@ import { input, confirm, select, checkbox } from "@inquirer/prompts"
 import * as y from "yoctocolors"
 import { action as secretAction } from "./secret.js"
 
-import { install } from "../lib/pkg-manager.js"
+import { getPkgManager, install } from "../lib/pkg-manager.js"
 import * as meta from "../lib/meta.js"
+import { updateEnvFile } from "../lib/write-env.js"
+import { mkdir } from "node:fs/promises"
 
 /**
  * @param {string} framework
@@ -89,6 +91,26 @@ async function createFromExample(framework, dir) {
  * @param {{framework: string, dir: string, providers: string[], adapter?: string}} options
  */
 async function scaffoldProject(options) {
-  console.log(options)
-  throw new Error("Not implemented")
+  const { framework, providers, dir, adapter } = options
+  const pkgManager = getPkgManager()
+  console.log(
+    `Scaffolding ${y.bold(framework)} project with ${y.bold(
+      pkgManager
+    )} at ${y.bold(dir)}...`
+  )
+  throw new Error("Scaffolding not implemented. Please use `init --example`")
+  console.log(`Create directory ${dir}`)
+  await mkdir(dir)
+  console.log(`Change directory to ${dir}`)
+  execSync(`cd ${dir}`)
+  console.log(`Initialize ${pkgManager} project`)
+  execSync(`${pkgManager} init`)
+  // console.log(`Add ${framework} to ${pkgManager}`)
+  // execSync(`${pkgManager} install ${framework}`)
+  for (const provider of providers) {
+    const id = `AUTH_${provider.toUpperCase()}_ID`
+    const secret = `AUTH_${provider.toUpperCase()}_SECRET`
+    await updateEnvFile(dir, id, "")
+    await updateEnvFile(dir, secret, "")
+  }
 }

commands/secret.js

@@ -3,9 +3,9 @@
 import * as y from "yoctocolors"
 import { write } from "../lib/clipboard/index.js"
 import { detectFramework } from "../lib/detect.js"
-import { readFile, writeFile } from "node:fs/promises"
 import { join } from "node:path"
-import prompt from "prompts"
+import { updateEnvFile } from "../lib/write-env.js"
+import { frameworks } from "../lib/meta.js"
 
 /** Web compatible method to create a random string of a given length */
 function randomString(size = 32) {
@@ -14,13 +14,6 @@ function randomString(size = 32) {
   return Buffer.from(bytes, "base64").toString("base64")
 }
 
-/** @type {Record<import("../lib/detect.js").SupportedFramework, string>} */
-export const frameworkDotEnvFile = {
-  nextjs: ".env.local",
-  express: ".env",
-  sveltekit: ".env",
-}
-
 /**
  * @param {{
  *  copy?: boolean
@@ -56,63 +49,18 @@ export async function action(options) {
     }
   }
 
-  if (options.write) {
-    try {
-      const framework = await detectFramework(options.path)
-      if (framework === "unknown") {
-        return console.log(
-          `No framework detected. Currently supported frameworks are: ${y.bold(
-            Object.keys(frameworkDotEnvFile).join(", ")
-          )}`
-        )
-      }
-      const dotEnvFile = frameworkDotEnvFile[framework]
-      await updateEnvFile(
-        dotEnvFile,
-        join(process.cwd(), options.path ?? "", dotEnvFile),
-        key,
-        value
+  try {
+    const framework = await detectFramework(options.path)
+    if (framework === "unknown") {
+      return console.log(
+        `No framework detected. Currently supported frameworks are: ${y.bold(
+          Object.keys(frameworks).join(", ")
+        )}`
       )
-    } catch (error) {
-      console.error(y.red(error))
     }
-  }
-}
 
-/**
- * Update a key-value pair to a .env file
- * @param {string} file
- * @param {string} envPath
- * @param {string} key
- * @param {string} value
- */
-async function updateEnvFile(file, envPath, key, value) {
-  let content = ""
-  const line = `${key}="${value}" # Added by \`npx auth\`. Read more: https://cli.authjs.dev`
-  try {
-    await readFile(envPath, "utf-8")
-    content = await readFile(envPath, "utf-8")
-    if (!content.includes(`${key}=`)) {
-      console.log(`➕ Added ${key} to ${y.italic(file)}.`)
-      content = `${line}\n${content}`
-    } else {
-      const { overwrite } = await prompt({
-        type: "confirm",
-        name: "overwrite",
-        message: `Overwrite existing ${key}?`,
-        initial: false,
-      })
-      if (!overwrite) return
-      console.log(`✨ Updated ${key} in ${y.italic(file)}.`)
-      content = content.replace(new RegExp(`${key}=(.*)`), `${line}`)
-    }
+    await updateEnvFile(options.path, key, value)
   } catch (error) {
-    if (error.code === "ENOENT") {
-      console.log(`📝 Created ${y.italic(file)} with ${key}.`)
-      content = line
-    } else {
-      throw error
-    }
+    console.error(y.red(error))
   }
-  if (content) await writeFile(envPath, content)
 }

index.js

@@ -49,8 +49,7 @@ program
   .command("secret")
   .option("--raw", "Output the string without any formatting.")
   .option("--copy", 'Copy AUTH_SECRET="value".')
-  .option("--write", 'Write AUTH_SECRET="value" to the .env file.')
-  .description("Generate a random string.")
+  .description("Generate a random string and add it to the .env file.")
   .action(secret.action)
 
 program.parse()

lib/detect.js

@@ -2,26 +2,22 @@
 import { readFile } from "node:fs/promises"
 import { join } from "node:path"
 
-/**
- * @typedef {"nextjs" | "express" | "sveltekit"} SupportedFramework
- */
-
 /**
  * When this function runs in a framework directory we support,
  * it will return the framework's name
  * @param {string} path
- * @returns {Promise<SupportedFramework | "unknown">}
+ * @returns {Promise<import("./meta").SupportedFramework | "unknown">}
  */
 export async function detectFramework(path = "") {
   const dir = process.cwd()
   const packageJsonPath = join(dir, path, "package.json")
   try {
     const packageJson = JSON.parse(await readFile(packageJsonPath, "utf-8"))
 
-    /** @type {SupportedFramework[]} */
+    /** @type {import("./meta").SupportedFramework[]} */
     const foundFrameworks = []
 
-    if (packageJson.dependencies["next"]) foundFrameworks.push("nextjs")
+    if (packageJson.dependencies["next"]) foundFrameworks.push("next")
     if (packageJson.dependencies["express"]) foundFrameworks.push("express")
     if (packageJson.devDependencies["@sveltejs/kit"])
       foundFrameworks.push("sveltekit")
@@ -35,7 +31,7 @@ export async function detectFramework(path = "") {
       return "unknown"
     }
     return "unknown"
-  } catch (error) {
+  } catch {
     return "unknown"
   }
 }

lib/meta.js

@@ -2,33 +2,140 @@
 
 // TODO: Get these programmatically
 
+/**
+ * @typedef {"next" | "express" | "sveltekit"} SupportedFramework
+ */
+
 export const frameworks = {
   next: {
     name: "Next.js",
     src: "https://github.com/nextauthjs/next-auth-example",
     demo: "https://next-auth-example.vercel.app",
+    envFile: ".env.local",
   },
   sveltekit: {
     name: "SvelteKit",
     src: "https://github.com/nextauthjs/sveltekit-auth-example",
     demo: "https://sveltekit-auth-example.vercel.app",
+    envFile: ".env",
   },
   express: {
     name: "Express",
     src: "https://github.com/nextauthjs/express-auth-example",
     demo: "https://express-auth-example.vercel.app",
+    envFile: ".env",
   },
 }
 
 export const providers = {
+  "42-school": "42 School",
+  apple: "Apple",
+  asgardeo: "Asgardeo",
+  auth0: "Auth0",
+  authentik: "Authentik",
+  "azure-ad-b2c": "Azure AD B2C",
+  "azure-ad": "Azure AD",
+  "azure-devops": "Azure DevOps",
+  battlenet: "Battlenet",
+  beyondidentity: "Beyond Identity",
+  box: "Box",
+  "boxyhq-saml": "Boxyhq SAML",
+  bungie: "Bungie",
+  "click-up": "Click-up",
+  cognito: "Cognito",
+  coinbase: "Coinbase",
+  credentials: "Credentials",
+  descope: "Descope",
+  discord: "Discord",
+  dribbble: "Dribbble",
+  dropbox: "Dropbox",
+  "duende-identity-server6": "Duende Identity Server 6",
+  email: "Email",
+  eveonline: "Eveonline",
+  facebook: "Facebook",
+  faceit: "Faceit",
+  foursquare: "Foursquare",
+  freshbooks: "Freshbooks",
+  fusionauth: "FusionAuth",
   github: "GitHub",
+  gitlab: "GitLab",
   google: "Google",
+  hubspot: "Hubspot",
+  "identity-server4": "Identity Server 4",
+  instagram: "Instagram",
+  kakao: "Kakao",
+  keycloak: "Keycloak",
+  line: "Line",
+  linkedin: "LinkedIn",
+  mailchimp: "Mailchimp",
+  mailru: "Mail.ru",
+  mastodon: "Mastodon",
+  mattermost: "Mattermost",
+  medium: "Medium",
+  "microsoft-entra-id": "Microsoft Entra ID",
+  naver: "Naver",
+  netlify: "Netlify",
+  netsuite: "Netsuite",
+  nodemailer: "Nodemailer",
+  notion: "Notion",
+  okta: "Okta",
+  onelogin: "Onelogin",
+  "ory-hydra": "Ory Hydra",
+  osso: "Osso",
+  osu: "Osu",
+  passage: "Passage",
+  passkey: "Passkey",
+  patreon: "Patreon",
+  pinterest: "Pinterest",
+  pipedrive: "Pipedrive",
+  postmark: "Postmark",
+  reddit: "Reddit",
   resend: "Resend",
+  salesforce: "Salesforce",
+  sendgrid: "Sendgrid",
+  slack: "Slack",
+  spotify: "Spotify",
+  strava: "Strava",
+  tiktok: "Tiktok",
+  todoist: "Todoist",
+  trakt: "Trakt",
+  twitch: "Twitch",
   twitter: "Twitter",
+  "united-effects": "United Effects",
+  vk: "Vk",
+  webex: "Webex",
+  wikimedia: "Wikimedia",
+  wordpress: "Wordpress",
+  workos: "WorkOS",
+  yandex: "Yandex",
+  zitadel: "Zitadel",
+  zoho: "Zoho",
+  zoom: "Zoom",
 }
 
 export const adapters = {
   none: "None",
+  "adapter-azure-tables": "Azure Tables",
+  d1: "d1",
+  dgraph: "Dgraph",
   drizzle: "Drizzle",
+  dynamodb: "DynamoDB",
+  edgedb: "EdgeDB",
+  fauna: "Fauna",
+  firebase: "Firebase",
+  hasura: "Hasura",
+  kysely: "Kysely",
+  "mikro-orm": "MikroORM",
+  mongodb: "MongoDB",
+  neo4j: "Neo4j",
+  pg: "PostgreSQL",
+  pouchdb: "PouchDB",
   prisma: "Prisma",
+  sequelize: "Sequelize",
+  supabase: "Supabase",
+  surrealdb: "SurrealDB",
+  typeorm: "TypeORM",
+  unstorage: "Unstorage",
+  "upstash-redis": "Upstash Redis",
+  xata: "Xata",
 }

lib/write-env.js

@@ -0,0 +1,47 @@
+// @ts-check
+
+import * as y from "yoctocolors"
+import { readFile, writeFile } from "node:fs/promises"
+import prompt from "prompts"
+import { join } from "node:path"
+import { frameworks } from "./meta.js"
+import { detectFramework } from "./detect.js"
+
+/**
+ * Update a key-value pair to a .env file
+ * @param {string|undefined} envPath
+ * @param {string} key
+ * @param {string} value
+ */
+export async function updateEnvFile(envPath = "", key, value) {
+  const framework = await detectFramework(envPath)
+  const dotEnvFile = frameworks[framework]?.envFile
+  let content = ""
+  const line = `${key}="${value}" # Added by \`npx auth\`. Read more: https://cli.authjs.dev`
+  const file = join(process.cwd(), envPath, dotEnvFile)
+  try {
+    content = await readFile(file, "utf-8")
+    if (!content.includes(`${key}=`)) {
+      console.log(`➕ Added ${key} to ${y.italic(file)}.`)
+      content = `${line}\n${content}`
+    } else {
+      const { overwrite } = await prompt({
+        type: "confirm",
+        name: "overwrite",
+        message: `Overwrite existing ${key}?`,
+        initial: false,
+      })
+      if (!overwrite) return
+      console.log(`✨ Updated ${key} in ${y.italic(file)}.`)
+      content = content.replace(new RegExp(`${key}=(.*)`), `${line}`)
+    }
+  } catch (error) {
+    if (error.code === "ENOENT") {
+      console.log(`📝 Created ${y.italic(file)} with ${key}.`)
+      content = line
+    } else {
+      throw error
+    }
+  }
+  if (content) await writeFile(file, content)
+}