create-catalyst-app 1.1.0 → 1.2.0-canary.2

package/templates/common/src/js/containers/Home/fonts/LICENSE-inter.txt

@@ -0,0 +1,93 @@
+Copyright 2016 The Inter Project Authors (https://github.com/rsms/inter) Inter-Italic[opsz,wght].ttf: Copyright 2016 The Inter Project Authors (https://github.com/rsms/inter)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/templates/common/src/js/containers/Home/fonts/LICENSE-jetbrains-mono.txt

@@ -0,0 +1,93 @@
+Copyright 2020 The JetBrains Mono Project Authors (https://github.com/JetBrains/JetBrainsMono) JetBrainsMono-Italic[wght].ttf: Copyright 2020 The JetBrains Mono Project Authors (https://github.com/JetBrains/JetBrainsMono)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/templates/common/src/js/routes/index.js

@@ -1,4 +1,7 @@
-import Home from "@containers/Home/Home"
+import { split } from "catalyst-core"
+
+// split() lets Catalyst run the page's serverFetcher and clientFetcher.
+const Home = split(() => import("@containers/Home/Home"))
 
 const routes = [
     {

package/templates/none-js/package.json

@@ -12,7 +12,11 @@
         "buildApp:android": "catalyst buildApp:android",
         "setupEmulator": "catalyst setupEmulator",
         "setupEmulator:ios": "catalyst setupEmulator:ios",
-        "setupEmulator:android": "catalyst setupEmulator:android"
+        "setupEmulator:android": "catalyst setupEmulator:android",
+        "android": "catalyst buildApp:android",
+        "ios": "catalyst buildApp:ios",
+        "android:release": "catalyst buildApp:android --release",
+        "ios:release": "catalyst buildApp:ios --release"
     },
     "_moduleAliases": {
         "@api": "api.js",
@@ -23,7 +27,7 @@
         "@routes": "src/js/routes/"
     },
     "dependencies": {
-        "catalyst-core": "1.1.0",
+        "catalyst-core": "1.2.0-canary.2",
         "react": "19.0.0",
         "react-dom": "19.0.0",
         "react-router": "^7.18.2"

package/templates/none-ts/package.json

@@ -13,6 +13,10 @@
         "setupEmulator": "catalyst setupEmulator",
         "setupEmulator:ios": "catalyst setupEmulator:ios",
         "setupEmulator:android": "catalyst setupEmulator:android",
+        "android": "catalyst buildApp:android",
+        "ios": "catalyst buildApp:ios",
+        "android:release": "catalyst buildApp:android --release",
+        "ios:release": "catalyst buildApp:ios --release",
         "typecheck": "tsc --noEmit"
     },
     "_moduleAliases": {
@@ -24,7 +28,7 @@
         "@routes": "src/js/routes/"
     },
     "dependencies": {
-        "catalyst-core": "1.1.0",
+        "catalyst-core": "1.2.0-canary.2",
         "react": "19.0.0",
         "react-dom": "19.0.0",
         "react-router": "^7.18.2"

package/templates/redux-js/package.json

@@ -12,7 +12,11 @@
         "buildApp:android": "catalyst buildApp:android",
         "setupEmulator": "catalyst setupEmulator",
         "setupEmulator:ios": "catalyst setupEmulator:ios",
-        "setupEmulator:android": "catalyst setupEmulator:android"
+        "setupEmulator:android": "catalyst setupEmulator:android",
+        "android": "catalyst buildApp:android",
+        "ios": "catalyst buildApp:ios",
+        "android:release": "catalyst buildApp:android --release",
+        "ios:release": "catalyst buildApp:ios --release"
     },
     "_moduleAliases": {
         "@api": "api.js",
@@ -26,7 +30,7 @@
     "dependencies": {
         "@reduxjs/toolkit": "^2.9.0",
         "react-redux": "^9.2.0",
-        "catalyst-core": "1.1.0",
+        "catalyst-core": "1.2.0-canary.2",
         "react": "19.0.0",
         "react-dom": "19.0.0",
         "react-router": "^7.18.2",

package/templates/redux-ts/package.json

@@ -13,6 +13,10 @@
         "setupEmulator": "catalyst setupEmulator",
         "setupEmulator:ios": "catalyst setupEmulator:ios",
         "setupEmulator:android": "catalyst setupEmulator:android",
+        "android": "catalyst buildApp:android",
+        "ios": "catalyst buildApp:ios",
+        "android:release": "catalyst buildApp:android --release",
+        "ios:release": "catalyst buildApp:ios --release",
         "typecheck": "tsc --noEmit"
     },
     "_moduleAliases": {
@@ -27,7 +31,7 @@
     "dependencies": {
         "@reduxjs/toolkit": "^2.9.0",
         "react-redux": "^9.2.0",
-        "catalyst-core": "1.1.0",
+        "catalyst-core": "1.2.0-canary.2",
         "react": "19.0.0",
         "react-dom": "19.0.0",
         "react-router": "^7.18.2",

package/templates/rtk-js/package.json

@@ -12,7 +12,11 @@
         "buildApp:android": "catalyst buildApp:android",
         "setupEmulator": "catalyst setupEmulator",
         "setupEmulator:ios": "catalyst setupEmulator:ios",
-        "setupEmulator:android": "catalyst setupEmulator:android"
+        "setupEmulator:android": "catalyst setupEmulator:android",
+        "android": "catalyst buildApp:android",
+        "ios": "catalyst buildApp:ios",
+        "android:release": "catalyst buildApp:android --release",
+        "ios:release": "catalyst buildApp:ios --release"
     },
     "_moduleAliases": {
         "@api": "api.js",
@@ -26,7 +30,7 @@
     "dependencies": {
         "@reduxjs/toolkit": "^2.9.0",
         "react-redux": "^9.2.0",
-        "catalyst-core": "1.1.0",
+        "catalyst-core": "1.2.0-canary.2",
         "react": "19.0.0",
         "react-dom": "19.0.0",
         "react-router": "^7.18.2",

package/templates/rtk-ts/package.json

@@ -13,6 +13,10 @@
         "setupEmulator": "catalyst setupEmulator",
         "setupEmulator:ios": "catalyst setupEmulator:ios",
         "setupEmulator:android": "catalyst setupEmulator:android",
+        "android": "catalyst buildApp:android",
+        "ios": "catalyst buildApp:ios",
+        "android:release": "catalyst buildApp:android --release",
+        "ios:release": "catalyst buildApp:ios --release",
         "typecheck": "tsc --noEmit"
     },
     "_moduleAliases": {
@@ -27,7 +31,7 @@
     "dependencies": {
         "@reduxjs/toolkit": "^2.9.0",
         "react-redux": "^9.2.0",
-        "catalyst-core": "1.1.0",
+        "catalyst-core": "1.2.0-canary.2",
         "react": "19.0.0",
         "react-dom": "19.0.0",
         "react-router": "^7.18.2",

package/test/appIdentity.test.ts

@@ -0,0 +1,142 @@
+// The app id, app name, native scripts, icon and .gitignore entries every
+// new app gets (scripts/appIdentity.cjs and the templates).
+const identity: typeof import("../scripts/appIdentity.cjs") = require("../scripts/appIdentity.cjs")
+const fs: typeof import("fs") = require("fs")
+const os: typeof import("os") = require("os")
+const path: typeof import("path") = require("path")
+
+const templates = path.join(__dirname, "..", "templates")
+const STARTERS = ["none-js", "none-ts", "redux-js", "redux-ts", "rtk-js", "rtk-ts"]
+
+const dirs: string[] = []
+afterEach(() => {
+    for (const dir of dirs.splice(0)) fs.rmSync(dir, { recursive: true, force: true })
+})
+
+describe("deriveAppId", () => {
+    it.each([
+        ["my-shop", "com.example.myshop"],
+        ["@acme/My_App", "com.example.myapp"],
+        ["123go", "com.example.app123go"],
+        ["class", "com.example.classapp"],
+        ["---", "com.example.app"],
+    ])("%s -> %s", (name, id) => {
+        expect(identity.deriveAppId(name)).toBe(id)
+    })
+})
+
+describe("deriveAppName", () => {
+    it.each([
+        ["my-shop", "My Shop"],
+        ["@acme/my-cool_app", "My Cool App"],
+        ["", "Catalyst App"],
+    ])("%s -> %s", (name, appName) => {
+        expect(identity.deriveAppName(name)).toBe(appName)
+    })
+})
+
+describe("applyAppIdentity", () => {
+    function app(): string {
+        const dir = fs.mkdtempSync(path.join(os.tmpdir(), "cca-identity-"))
+        dirs.push(dir)
+        fs.cpSync(path.join(templates, "common", "config"), path.join(dir, "config"), { recursive: true })
+        return dir
+    }
+
+    it("sets the derived id and name and changes nothing else in the file", () => {
+        const dir = app()
+        const file = path.join(dir, "config", "config.json")
+        const before = fs.readFileSync(file, "utf8")
+        expect(identity.applyAppIdentity(dir, "my-shop")).toBe(true)
+        const after = fs.readFileSync(file, "utf8")
+        const config = JSON.parse(after)
+        expect(config.WEBVIEW_CONFIG.appId).toBe("com.example.myshop")
+        expect(config.WEBVIEW_CONFIG.appName).toBe("My Shop")
+        const changed = after
+            .split("\n")
+            .filter((line: string, index: number) => line !== before.split("\n")[index])
+        expect(changed).toHaveLength(2)
+    })
+
+    it("adds the keys to a config that lacks them", () => {
+        const dir = app()
+        const file = path.join(dir, "config", "config.json")
+        fs.writeFileSync(file, JSON.stringify({ WEBVIEW_CONFIG: { port: "3005" } }))
+        expect(identity.applyAppIdentity(dir, "shop")).toBe(true)
+        expect(JSON.parse(fs.readFileSync(file, "utf8")).WEBVIEW_CONFIG).toEqual({
+            appId: "com.example.shop",
+            appName: "Shop",
+            port: "3005",
+        })
+    })
+
+    it("writes nothing when config.json is missing or not JSON", () => {
+        const dir = app()
+        const file = path.join(dir, "config", "config.json")
+        fs.writeFileSync(file, "{ not json")
+        expect(identity.applyAppIdentity(dir, "shop")).toBe(false)
+        expect(fs.readFileSync(file, "utf8")).toBe("{ not json")
+        fs.rmSync(file)
+        expect(identity.applyAppIdentity(dir, "shop")).toBe(false)
+        expect(fs.existsSync(file)).toBe(false)
+    })
+
+    it("leaves a config without WEBVIEW_CONFIG alone", () => {
+        const dir = app()
+        const file = path.join(dir, "config", "config.json")
+        fs.writeFileSync(file, "{}")
+        expect(identity.applyAppIdentity(dir, "shop")).toBe(false)
+        expect(fs.readFileSync(file, "utf8")).toBe("{}")
+    })
+})
+
+describe("templates", () => {
+    it("ship appId and appName placeholders in the shared config", () => {
+        const config = JSON.parse(
+            fs.readFileSync(path.join(templates, "common", "config", "config.json"), "utf8")
+        )
+        expect(config.WEBVIEW_CONFIG).toMatchObject({
+            appId: expect.any(String),
+            appName: expect.any(String),
+        })
+    })
+
+    it("ship a square 1024 px opaque icon at public/icon.png", () => {
+        const png = fs.readFileSync(path.join(templates, "common", "public", "icon.png"))
+        expect(png.subarray(1, 4).toString()).toBe("PNG")
+        expect(png.readUInt32BE(16)).toBe(1024)
+        expect(png.readUInt32BE(20)).toBe(1024)
+        // Colour type 2: RGB, no alpha (App Store Connect rejects alpha).
+        expect(png[25]).toBe(2)
+    })
+
+    it.each(STARTERS)("%s has the native scripts", (starter) => {
+        const pkg = JSON.parse(fs.readFileSync(path.join(templates, starter, "package.json"), "utf8"))
+        expect(pkg.scripts).toMatchObject({
+            android: "catalyst buildApp:android",
+            ios: "catalyst buildApp:ios",
+            "android:release": "catalyst buildApp:android --release",
+            "ios:release": "catalyst buildApp:ios --release",
+        })
+    })
+
+    it("no longer ship the native-only template", () => {
+        expect(fs.existsSync(path.join(templates, "native"))).toBe(false)
+        expect(fs.existsSync(path.join(__dirname, "..", "scripts", "native.cjs"))).toBe(false)
+    })
+})
+
+describe("cli.cjs", () => {
+    const cli = fs.readFileSync(path.join(__dirname, "..", "scripts", "cli.cjs"), "utf8")
+
+    it("ignores credentials/, .catalyst/ and build-output/", () => {
+        for (const entry of ["credentials/", ".catalyst/", "build-output/"])
+            expect(cli).toContain(`"${entry}"`)
+    })
+
+    it("has no native prompt or flags", () => {
+        expect(cli).not.toContain("--native")
+        expect(cli).not.toContain("--app-id")
+        expect(cli).toContain("applyAppIdentity")
+    })
+})

package/test/errors.test.ts

@@ -206,6 +206,46 @@ describe("formatError() — same 3-mode contract (default/verbose/debug) as cata
     })
 })
 
+describe("formatError() with a cause or details", () => {
+    const strip = (text: string) => text.replace(new RegExp(`${String.fromCharCode(27)}\\[[0-9;]*m`, "g"), "")
+
+    it("default mode shows the cause's message, or the details when there is no cause", () => {
+        const caused = cca.createError(cca.ERROR_CODES.CCA_UPSTREAM_ERROR, { cause: new Error("npm ERR! 404") })
+        expect(cca.formatError(caused)).toContain("npm ERR! 404")
+        const plain = cca.createError(cca.ERROR_CODES.CCA_UPSTREAM_ERROR, { cause: "exit code 7" as any })
+        expect(cca.formatError(plain)).toContain("exit code 7")
+        const detailed = cca.createError(cca.ERROR_CODES.CCA_DIRECTORY_EXISTS, { details: "./shop is not empty" })
+        expect(cca.formatError(detailed).split("\n")[1]).toBe("./shop is not empty")
+    })
+
+    it("verbose mode names the problem from the cause, else the details", () => {
+        const caused = cca.createError(cca.ERROR_CODES.CCA_UPSTREAM_ERROR, { cause: new Error("ETIMEDOUT") })
+        expect(strip(cca.formatError(caused, "verbose"))).toContain("Problem: ETIMEDOUT")
+        const detailed = cca.createError(cca.ERROR_CODES.CCA_DIRECTORY_EXISTS, { details: "./shop is not empty" })
+        expect(strip(cca.formatError(detailed, "verbose"))).toContain("Problem: ./shop is not empty")
+    })
+
+    it("debug mode without a cause shows the details and the error's own stack", () => {
+        const err = cca.createError(cca.ERROR_CODES.CCA_DIRECTORY_EXISTS, { details: "./shop is not empty" })
+        const output = strip(cca.formatError(err, "debug"))
+        expect(output).toContain("Problem: ./shop is not empty")
+        expect(output).not.toContain("Environment:")
+        expect(output).toContain("Stack trace:")
+        expect(output).toContain(String(err.stack).split("\n")[0])
+        const stackless = Object.assign(cca.createError(cca.ERROR_CODES.CCA_DIRECTORY_EXISTS), { stack: "" })
+        expect(strip(cca.formatError(stackless, "debug"))).toContain("(no stack available)")
+    })
+
+    it("getDebugEnvInfo reports node, platform and this package's version", () => {
+        const info = cca.getDebugEnvInfo()
+        expect(info).toEqual({
+            node: process.version,
+            platform: process.platform,
+            createCatalystApp: require("../package.json").version,
+        })
+    })
+})
+
 describe("resolveOutputMode() — same bare-flag contract as scriptUtils.js#resolveOutputMode", () => {
     it("detects --debug and --verbose from an argv array", () => {
         expect(cca.resolveOutputMode(["node", "cli.js", "--debug"])).toBe("debug")