@starci/hfs 2.0.2 → 4.0.0

package/templates/fe/hooks/husky/pre-commit

@@ -1,16 +0,0 @@
-{{header}}
-# Commit gate: the secrets guard, then types, lint and format of the staged files.
-npx hfs work-hygiene
-npm run typecheck
-sources=$(git diff --cached --name-only --diff-filter=ACMR -- '*.ts' '*.tsx' '*.mts' '*.cts' '*.js' '*.jsx' '*.mjs' '*.cjs' || true)
-if [ -n "$sources" ]; then
-  npx eslint --max-warnings=0 --no-warn-ignored $sources
-fi
-styles=$(git diff --cached --name-only --diff-filter=ACMR -- '*.css' || true)
-if [ -n "$styles" ]; then
-  npx stylelint $styles
-fi
-formatted=$(git diff --cached --name-only --diff-filter=ACMR || true)
-if [ -n "$formatted" ]; then
-  npx prettier --check --ignore-unknown $formatted
-fi

package/templates/fe/hooks/husky/pre-push

@@ -1,6 +0,0 @@
-{{header}}
-# Push gate: types, lint (eslint over the repository, stylelint over the CSS), format, the architecture check on the owners this push touches.
-npm run typecheck
-npm run lint:check
-npm run format:check
-npm run hfs:check -- --fast

package/templates/fe/package-scripts/package.json

@@ -1,17 +0,0 @@
-{
-  "scripts": {
-    "prepare": "husky",
-    {{appScripts}}
-    "codegen": "npm run codegen --workspaces --if-present",
-    "build": "npm run build --workspaces --if-present",
-    "typecheck": "npm run typecheck --workspaces --if-present",
-    "lint": "npm run codegen --silent && eslint . --fix --max-warnings=0 && stylelint \"{{styleGlob}}\" --fix",
-    "lint:check": "npm run codegen --silent && eslint . --max-warnings=0 && stylelint \"{{styleGlob}}\"",
-    "lint:report": "eslint . --format json --output-file reports/eslint.json",
-    "lint:report:css": "stylelint \"{{styleGlob}}\" --formatter json --output-file reports/stylelint.json",
-    "format": "prettier --write .",
-    "format:check": "prettier --check .",
-    "hfs:check": "hfs check",
-    "hfs:report": "hfs check --sonar reports/hfs.sonar.json"
-  }
-}

package/templates/fe/parts/api-client.ts

@@ -1,44 +0,0 @@
-import type { Outcome } from "./outcome"
-
-/** How long a request waits before it is abandoned and answered `unavailable`. */
-const REQUEST_TIMEOUT_MS = 8000
-
-/** One request of the client: the caller's own signal is joined with the timeout. */
-export interface ClientRequest {
-    readonly url: string
-    readonly method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE"
-    readonly body?: unknown
-    readonly signal?: AbortSignal
-}
-
-/** The status of a response as an Outcome kind; 401 and 403 are `refused`, nothing collapses into `null`. */
-const toOutcome = async (response: Response): Promise<Outcome<unknown>> => {
-    if (response.status === 401 || response.status === 403) return { kind: "refused" }
-    if (response.status === 404) return { kind: "not-found" }
-    if (response.status === 400 || response.status === 422) return { kind: "invalid" }
-    if (!response.ok) return { kind: "unavailable" }
-    try {
-        return { kind: "ok", data: (await response.json()) as unknown }
-    } catch {
-        return { kind: "unavailable" }
-    }
-}
-
-/**
- * The repository's one fetch. It always carries a timeout signal, never throws, and answers an Outcome; the body is
- * `unknown` until a generated wire type narrows it.
- */
-export const request = async ({ url, method = "GET", body, signal }: ClientRequest): Promise<Outcome<unknown>> => {
-    const timeout = AbortSignal.timeout(REQUEST_TIMEOUT_MS)
-    try {
-        const response = await fetch(url, {
-            method,
-            headers: { accept: "application/json", ...(body === undefined ? {} : { "content-type": "application/json" }) },
-            ...(body === undefined ? {} : { body: JSON.stringify(body) }),
-            signal: signal === undefined ? timeout : AbortSignal.any([signal, timeout]),
-        })
-        return await toOutcome(response)
-    } catch {
-        return { kind: "unavailable" }
-    }
-}

package/templates/fe/parts/api-outcome.ts

@@ -1,7 +0,0 @@
-/** The one result every read of the backend returns: a status is a kind, never a thrown error and never `null`. */
-export type Outcome<T> =
-    | { readonly kind: "ok"; readonly data: T }
-    | { readonly kind: "refused" }
-    | { readonly kind: "invalid" }
-    | { readonly kind: "not-found" }
-    | { readonly kind: "unavailable" }

package/templates/fe/quality-config/sonar-project.properties

@@ -1,8 +0,0 @@
-{{header}}
-sonar.projectKey={{sonarKey}}
-sonar.sourceEncoding=UTF-8
-sonar.sources={{sonarRoots}}
-sonar.exclusions=**/.next/**,**/node_modules/**,**/src/messages/**
-sonar.typescript.tsconfigPaths={{tsconfigPaths}}
-sonar.externalIssuesReportPaths=reports/hfs.sonar.json,reports/eslint.sonar.json,reports/stylelint.sonar.json
-sonar.nodejs.maxspace=8192

package/templates/fe/skeleton-app/apps/__app__/src/modules/api/client.ts

@@ -1 +0,0 @@
-{{> fe/parts/api-client.ts}}

package/templates/fe/skeleton-app/apps/__app__/src/modules/api/index.ts

@@ -1,3 +0,0 @@
-export { request } from "./client"
-export type { ClientRequest } from "./client"
-export type { Outcome } from "./outcome"

package/templates/fe/skeleton-app/apps/__app__/src/modules/api/outcome.ts

@@ -1 +0,0 @@
-{{> fe/parts/api-outcome.ts}}

package/templates/fe/skeleton-app/apps/__app__/src/modules/i18n/index.ts

@@ -1,4 +0,0 @@
-export { DEFAULT_LOCALE, LOCALES } from "./config"
-export type { Locale } from "./config"
-export { getPathname, Link, redirect, usePathname, useRouter } from "./navigation"
-export { routing } from "./routing"

package/templates/fe/skeleton-app/apps/__app__/src/modules/i18n/navigation.ts

@@ -1,5 +0,0 @@
-import { createNavigation } from "next-intl/navigation"
-import { routing } from "./routing"
-
-/** Locale-aware links and navigation; components import these instead of `next/link` and `next/navigation`. */
-export const { Link, redirect, usePathname, useRouter, getPathname } = createNavigation(routing)

package/templates/fe/skeleton-shared/apps/__app__/next.config.ts

@@ -1,12 +0,0 @@
-import type { NextConfig } from "next"
-import createNextIntlPlugin from "next-intl/plugin"
-
-const withNextIntl = createNextIntlPlugin("./src/modules/i18n/request.ts")
-
-/** Next config of the {{app}} app: next-intl wired to the request config, Turbopack rooted at the repository, the shared packages compiled from source. */
-const nextConfig: NextConfig = {
-    turbopack: { root: process.cwd() },
-    transpilePackages: ["@{{family}}/i18n", "@{{family}}/api"],
-}
-
-export default withNextIntl(nextConfig)

package/templates/fe/skeleton-shared/apps/__app__/src/modules/api/index.ts

@@ -1,2 +0,0 @@
-export { request } from "@{{family}}/api"
-export type { ClientRequest, Outcome } from "@{{family}}/api"

package/templates/fe/skeleton-shared/apps/__app__/src/modules/i18n/index.ts

@@ -1,9 +0,0 @@
-import { createAppI18n } from "@{{family}}/i18n"
-
-/** This app's locales and the next-intl stack (routing, navigation) built from them by the shared i18n package. */
-const i18n = createAppI18n({ locales: ["vi"], defaultLocale: "vi" })
-
-export const { DEFAULT_LOCALE, LOCALES, getPathname, Link, redirect, routing, usePathname, useRouter } = i18n
-
-/** A served locale. */
-export type Locale = (typeof LOCALES)[number]

package/templates/fe/skeleton-shared/apps/__app__/src/modules/i18n/request.ts

@@ -1,5 +0,0 @@
-import { createRequestConfig } from "@{{family}}/i18n/request"
-import { routing } from "./index"
-
-/** Loads the catalog of the requested locale from this app's `messages/`; the shared package resolves the locale. */
-export default createRequestConfig(routing, async (locale) => (await import(`./messages/${locale}.json`)).default)

package/templates/fe/skeleton-shared/apps/__app__/src/proxy.ts

@@ -1,5 +0,0 @@
-import { createProxy } from "@{{family}}/i18n/proxy"
-import { routing } from "./modules/i18n"
-
-/** Negotiates the locale and redirects; the default locale (vi) is served without a prefix. */
-export default createProxy(routing)

package/templates/fe/skeleton-shared/packages/__family__-api/package.json

@@ -1,12 +0,0 @@
-{
-  "name": "@{{family}}/api",
-  "version": "0.1.0",
-  "private": true,
-  "type": "module",
-  "exports": {
-    ".": "./src/index.ts"
-  },
-  "scripts": {
-    "typecheck": "tsc --noEmit --pretty false"
-  }
-}

package/templates/fe/skeleton-shared/packages/__family__-api/src/client.ts

@@ -1 +0,0 @@
-{{> fe/parts/api-client.ts}}

package/templates/fe/skeleton-shared/packages/__family__-api/src/index.ts

@@ -1,3 +0,0 @@
-export { request } from "./client"
-export type { ClientRequest } from "./client"
-export type { Outcome } from "./outcome"

package/templates/fe/skeleton-shared/packages/__family__-api/src/outcome.ts

@@ -1 +0,0 @@
-{{> fe/parts/api-outcome.ts}}

package/templates/fe/skeleton-shared/packages/__family__-api/tsconfig.json

@@ -1,5 +0,0 @@
-{
-  "extends": "@starci/tsconfig/next.json",
-  "include": ["src/**/*.ts", "src/**/*.tsx"],
-  "exclude": ["node_modules"]
-}

package/templates/fe/skeleton-shared/packages/__family__-i18n/package.json

@@ -1,18 +0,0 @@
-{
-  "name": "@{{family}}/i18n",
-  "version": "0.1.0",
-  "private": true,
-  "type": "module",
-  "exports": {
-    ".": "./src/index.ts",
-    "./proxy": "./src/proxy.ts",
-    "./request": "./src/request.ts"
-  },
-  "scripts": {
-    "typecheck": "tsc --noEmit --pretty false"
-  },
-  "peerDependencies": {
-    "next": ">=16",
-    "next-intl": ">=4"
-  }
-}

package/templates/fe/skeleton-shared/packages/__family__-i18n/src/app.ts

@@ -1,19 +0,0 @@
-import { createNavigation } from "next-intl/navigation"
-import { defineRouting } from "next-intl/routing"
-
-/** The locales an app serves and the one it serves at the unprefixed path. */
-export interface AppI18nOptions<Locale extends string> {
-    readonly locales: readonly [Locale, ...Locale[]]
-    readonly defaultLocale: Locale
-}
-
-/**
- * The next-intl stack of one app, written once for the repository: one routing table (default locale unprefixed) and the
- * locale-aware navigation built on it. Components import `Link` and `redirect` from their app's i18n module, never from
- * `next/link` or `next/navigation`. The proxy and the request config are the `./proxy` and `./request` entries, so a client
- * bundle that imports this one carries no server code.
- */
-export const createAppI18n = <const Locale extends string>({ locales, defaultLocale }: AppI18nOptions<Locale>) => {
-    const routing = defineRouting({ locales, defaultLocale, localePrefix: "as-needed" })
-    return { LOCALES: locales, DEFAULT_LOCALE: defaultLocale, routing, ...createNavigation(routing) }
-}

package/templates/fe/skeleton-shared/packages/__family__-i18n/src/index.ts

@@ -1,2 +0,0 @@
-export { createAppI18n } from "./app"
-export type { AppI18nOptions } from "./app"

package/templates/fe/skeleton-shared/packages/__family__-i18n/src/proxy.ts

@@ -1,12 +0,0 @@
-import createMiddleware from "next-intl/middleware"
-import type { defineRouting } from "next-intl/routing"
-import { NextResponse, type NextRequest } from "next/server"
-
-/** The API, the health probe, framework files and files with an extension are never locale-negotiated. */
-const UNNEGOTIATED = /^\/(?:api|health|_next|_vercel)(?:\/|$)|\.[^/]+$/
-
-/** The proxy of an app: negotiates the locale and redirects, and lets everything that is not a page through untouched. */
-export const createProxy = (routing: ReturnType<typeof defineRouting>) => {
-    const negotiate = createMiddleware(routing)
-    return (request: NextRequest) => (UNNEGOTIATED.test(request.nextUrl.pathname) ? NextResponse.next() : negotiate(request))
-}

package/templates/fe/skeleton-shared/packages/__family__-i18n/src/request.ts

@@ -1,15 +0,0 @@
-import { hasLocale } from "next-intl"
-import type { defineRouting } from "next-intl/routing"
-import { getRequestConfig } from "next-intl/server"
-
-type Routing = ReturnType<typeof defineRouting>
-
-/** The requested locale when the app serves it, else the default one. */
-export const resolveLocale = (routing: Routing, requested: string | undefined): string => (hasLocale(routing.locales, requested) ? requested : routing.defaultLocale)
-
-/** The request config of an app: the resolved locale and the catalog the app loads for it. */
-export const createRequestConfig = (routing: Routing, loadMessages: (locale: string) => Promise<Record<string, unknown>>) =>
-    getRequestConfig(async ({ requestLocale }) => {
-        const locale = resolveLocale(routing, await requestLocale)
-        return { locale, messages: await loadMessages(locale) }
-    })

package/templates/fe/skeleton-shared/packages/__family__-i18n/tsconfig.json

@@ -1,5 +0,0 @@
-{
-  "extends": "@starci/tsconfig/next.json",
-  "include": ["src/**/*.ts", "src/**/*.tsx"],
-  "exclude": ["node_modules"]
-}

package/templates/fe/tool-config/prettierrc

@@ -1 +0,0 @@
-"@starci/prettier-config"