@doki-land/nifty 0.1.1 → 0.1.2

package/src/cli/upload.ts

@@ -9,37 +9,37 @@ import { loadNiftyNative } from "../native.js";
 const USER_AGENT = "nifty-upload";
 
 export type UploadOptions = {
-    release : boolean;
-    pages : boolean;
-    both : boolean;
-    dir : string;
-    tag ? : string;
-    repo ? : string;
-    token ? : string;
-    name ? : string;
-    notes ? : string;
-    notesFile ? : string;
-    draft : boolean;
-    generateNotes : boolean;
-    githubAction : boolean;
-    cwd ? : string;
+    release: boolean;
+    pages: boolean;
+    both: boolean;
+    dir: string;
+    tag?: string;
+    repo?: string;
+    token?: string;
+    name?: string;
+    notes?: string;
+    notesFile?: string;
+    draft: boolean;
+    generateNotes: boolean;
+    githubAction: boolean;
+    cwd?: string;
 };
 
 type GithubRelease = {
-    id : number;
+    id: number;
 };
 
-export async function runUpload(argv : string[]) : Promise<void>{
+export async function runUpload(argv: string[]): Promise < void> {
     await uploadFromOptions(parseUploadArgs(argv));
 }
 
-export async function uploadFromOptions(options : UploadOptions) : Promise<void>{
-    if(options.githubAction){
+export async function uploadFromOptions(options: UploadOptions): Promise < void> {
+    if (options.githubAction) {
         applyGithubActionDefaults(options);
     }
 
     const token = options.token ?? process.env.GITHUB_TOKEN;
-    if(!token){
+    if (!token) {
         throw new Error("GitHub token is required (set --token or GITHUB_TOKEN)");
     }
 
@@ -50,117 +50,117 @@ export async function uploadFromOptions(options : UploadOptions) : Promise<void>
         options.repo ??
         native.git["detect-github-repo"](layout.root) ??
         process.env.GITHUB_REPOSITORY;
-    if(!repo){
+    if (!repo) {
         throw new Error("could not detect GitHub repo (use --repo owner/name)");
     }
 
     const tag = options.tag ?? process.env.GITHUB_REF_NAME;
-    if(!tag){
+    if (!tag) {
         throw new Error("release tag is required (use --tag or push a git tag)");
     }
 
     const target = parseTarget(options);
     const notes = await resolveNotes(options, layout.root, tag, native);
 
-    if(target === "release" || target === "both"){
+    if (target === "release" || target === "both") {
         await uploadReleaseAssets(repo, token, tag, options, notes);
     }
-    if(target === "pages" || target === "both"){
+    if (target === "pages" || target === "both") {
         await deployGithubPages(repo, token, options.dir);
     }
 }
 
-function parseUploadArgs(argv : string[]) : UploadOptions {
-    const options : UploadOptions = {
-        release : false,
-        pages : false,
-        both : false,
-        dir : "dist",
-        draft : false,
-        generateNotes : true,
-        githubAction : false,
+function parseUploadArgs(argv: string[]): UploadOptions {
+    const options: UploadOptions = {
+        release: false,
+        pages: false,
+        both: false,
+        dir: "dist",
+        draft: false,
+        generateNotes: true,
+        githubAction: false,
     };
 
-    for(let i = 0; i<argv.length; i += 1){
+    for (let i = 0; i < argv.length; i += 1) {
         const arg = argv[i];
-        if(arg === "--release")options.release = true;
-        else if(arg === "--pages")options.pages = true;
-        else if(arg === "--both")options.both = true;
-        else if(arg === "-d" || arg === "--dir")options.dir = argv[ ++ i];
-        else if(arg === "-h" || arg === "--help"){
+        if (arg === "--release")options.release = true;
+        else if (arg === "--pages")options.pages = true;
+        else if (arg === "--both")options.both = true;
+        else if (arg === "-d" || arg === "--dir")options.dir = argv[++i];
+        else if (arg === "-h" || arg === "--help") {
             printUploadHelp();
             process.exit(0);
         }
-        else if(arg === "-t" || arg === "--tag")options.tag = argv[ ++ i];
-        else if(arg === "--repo")options.repo = argv[ ++ i];
-        else if(arg === "--token")options.token = argv[ ++ i];
-        else if(arg === "--name")options.name = argv[ ++ i];
-        else if(arg === "--notes")options.notes = argv[ ++ i];
-        else if(arg === "--notes-file")options.notesFile = argv[ ++ i];
-        else if(arg === "--draft")options.draft = true;
-        else if(arg === "--no-generate-notes")options.generateNotes = false;
-        else if(arg === "--github-action")options.githubAction = true;
-        else if(arg === "-C" || arg === "--cwd")options.cwd = argv[ ++ i];
+        else if (arg === "-t" || arg === "--tag")options.tag = argv[++i];
+        else if (arg === "--repo")options.repo = argv[++i];
+        else if (arg === "--token")options.token = argv[++i];
+        else if (arg === "--name")options.name = argv[++i];
+        else if (arg === "--notes")options.notes = argv[++i];
+        else if (arg === "--notes-file")options.notesFile = argv[++i];
+        else if (arg === "--draft")options.draft = true;
+        else if (arg === "--no-generate-notes")options.generateNotes = false;
+        else if (arg === "--github-action")options.githubAction = true;
+        else if (arg === "-C" || arg === "--cwd")options.cwd = argv[++i];
     }
 
     return options;
 }
 
-function parseTarget(options : UploadOptions) : "release" | "pages" | "both"{
-    if(options.both)return "both";
-    if(options.pages)return "pages";
-    if(options.release)return "release";
+function parseTarget(options: UploadOptions): "release" | "pages" | "both" {
+    if (options.both)return "both";
+    if (options.pages)return "pages";
+    if (options.release)return "release";
     throw new Error("specify --release, --pages, or --both");
 }
 
-function applyGithubActionDefaults(options : UploadOptions) : void {
-    options.token ??= process.env.GITHUB_TOKEN;
-    options.repo ??= process.env.GITHUB_REPOSITORY;
-    options.tag ??= process.env.GITHUB_REF_NAME;
-    options.cwd ??= process.env.GITHUB_WORKSPACE;
+function applyGithubActionDefaults(options: UploadOptions): void {
+    options.token??= process.env.GITHUB_TOKEN;
+    options.repo??= process.env.GITHUB_REPOSITORY;
+    options.tag??= process.env.GITHUB_REF_NAME;
+    options.cwd??= process.env.GITHUB_WORKSPACE;
 }
 
 async function resolveNotes(
-    options : UploadOptions,
-    repoRoot : string,
-    tag : string,
-    native : ReturnType<typeof loadNiftyNative>,
-) : Promise<string>{
-    if(options.notes)return options.notes;
-    if(options.notesFile)return readFileSync(options.notesFile, "utf8");
-    if(!options.generateNotes)return "";
+    options: UploadOptions,
+    repoRoot: string,
+    tag: string,
+    native: ReturnType < typeof loadNiftyNative > ,
+): Promise < string> {
+    if (options.notes)return options.notes;
+    if (options.notesFile)return readFileSync(options.notesFile, "utf8");
+    if (!options.generateNotes)return "";
     try {
-        const range = native.git["resolve-range"](repoRoot, tag.replace( /^v/ , ""), undefined, tag);
+        const range = native.git["resolve-range"](repoRoot, tag.replace(/^v/, ""), undefined, tag);
         const commits = native.git["collect-commits"](repoRoot, range["from-ref"], range["to-ref"]);
-        return commits.map((commit) =>`- ${commit.body}`).join("\n");
+        return commits.map((commit) => `- ${commit.body}`).join("\n");
     } catch {
         return "";
     }
 }
 
 async function uploadReleaseAssets(
-    repo : string,
-    token : string,
-    tag : string,
-    options : UploadOptions,
-    notes : string,
-) : Promise<void>{
+    repo: string,
+    token: string,
+    tag: string,
+    options: UploadOptions,
+    notes: string,
+): Promise < void> {
     const[owner, name] = splitRepo(repo);
     let release = await apiReleaseByTag(owner, name, tag, token);
-    if(!release){
+    if (!release) {
         release = await apiCreateRelease(owner, name, tag, options.name ?? tag, notes, options.draft, token);
     }
     const cwd = options.cwd ?? process.cwd();
     const files = collectFiles(resolve(cwd, options.dir));
-    for(const file of files){
+    for (const file of files) {
         const asset =
-            relative(resolve(cwd, options.dir), file).split( /[/\\]/ ).join("-") || basename(file);
+            relative(resolve(cwd, options.dir), file).split(/[/\\]/).join("-") || basename(file);
         await apiUploadAsset(owner, name, release.id, asset, file, token);
         console.log(`release: uploaded ${asset}`);
     }
 }
 
-function printUploadHelp() : void {
+function printUploadHelp(): void {
     console.log(`nifty upload — GitHub Release assets and/or GitHub Pages
 
 Usage:
@@ -178,13 +178,13 @@ Options:
 `);
 }
 
-async function deployGithubPages(repo : string, token : string, dir : string) : Promise<void>{
+async function deployGithubPages(repo: string, token: string, dir: string): Promise < void> {
     const[owner, name] = splitRepo(repo);
     const source = resolve(dir);
     const work = mkdtempSync(join(tmpdir(), "nifty-pages-"));
-    cpSync(source, work, { recursive : true });
+    cpSync(source, work, { recursive: true });
     const nojekyll = join(work, ".nojekyll");
-    if(!existsSync(nojekyll)){
+    if (!existsSync(nojekyll)) {
         writeFileSync(nojekyll, "");
     }
     git(work, ["init"]);
@@ -198,21 +198,21 @@ async function deployGithubPages(repo : string, token : string, dir : string) :
     console.log(`pages: pushed ${source} to gh-pages`);
 }
 
-function collectFiles(dir : string) : string[]{
-    const out : string[] = [];
-    for(const entry of walk(dir)){
-        if(statSync(entry).isFile()){
+function collectFiles(dir: string): string[] {
+    const out: string[] = [];
+    for (const entry of walk(dir)) {
+        if (statSync(entry).isFile()) {
             out.push(entry);
         }
     }
     return out;
 }
 
-function walk(dir : string) : string[]{
-    const files : string[] = [];
-    for(const entry of readdirSync(dir)){
+function walk(dir: string): string[] {
+    const files: string[] = [];
+    for (const entry of readdirSync(dir)) {
         const path = join(dir, entry);
-        if(statSync(path).isDirectory()){
+        if (statSync(path).isDirectory()) {
             files.push(...walk(path));
         } else {
             files.push(path);
@@ -221,93 +221,93 @@ function walk(dir : string) : string[]{
     return files;
 }
 
-function splitRepo(repo : string) : [string, string]{
+function splitRepo(repo: string): [string, string] {
     const parts = repo.split("/");
-    if(parts.length!== 2 || !parts[0] || !parts[1]){
+    if (parts.length !== 2 || !parts[0] || !parts[1]) {
         throw new Error(`invalid repo ${repo}, expected owner/name`);
     }
     return[parts[0], parts[1]];
 }
 
 async function apiReleaseByTag(
-    owner : string,
-    name : string,
-    tag : string,
-    token : string,
-) : Promise<GithubRelease | null>{
+    owner: string,
+    name: string,
+    tag: string,
+    token: string,
+): Promise < GithubRelease | null > {
     const response = await fetch(
         `https://api.github.com/repos/${owner}/${name}/releases/tags/${encodeURIComponent(tag)}`,
-        { headers : githubHeaders(token) },
+        { headers: githubHeaders(token) },
     );
-    if(response.status === 404)return null;
-    if(!response.ok){
+    if (response.status === 404)return null;
+    if (!response.ok) {
         throw new Error(`GitHub API ${response.status}: ${await response.text()}`);
     }
     return(await response.json())as GithubRelease;
 }
 
 async function apiCreateRelease(
-    owner : string,
-    name : string,
-    tag : string,
-    title : string,
-    body : string,
-    draft : boolean,
-    token : string,
-) : Promise<GithubRelease>{
+    owner: string,
+    name: string,
+    tag: string,
+    title: string,
+    body: string,
+    draft: boolean,
+    token: string,
+): Promise < GithubRelease> {
     const response = await fetch(`https://api.github.com/repos/${owner}/${name}/releases`, {
-        method : "POST",
-        headers : { ...githubHeaders(token), "Content-Type" : "application/json" },
-        body : JSON.stringify({ tag_name : tag, name : title, body, draft }),
+        method: "POST",
+        headers: { ...githubHeaders(token), "Content-Type": "application/json" },
+        body: JSON.stringify({ tag_name: tag, name: title, body, draft }),
     });
-    if(!response.ok){
+    if (!response.ok) {
         throw new Error(`GitHub API ${response.status}: ${await response.text()}`);
     }
     return(await response.json())as GithubRelease;
 }
 
 async function apiUploadAsset(
-    owner : string,
-    name : string,
-    releaseId : number,
-    assetName : string,
-    filePath : string,
-    token : string,
-) : Promise<void>{
+    owner: string,
+    name: string,
+    releaseId: number,
+    assetName: string,
+    filePath: string,
+    token: string,
+): Promise < void> {
     const url = `https://uploads.github.com/repos/${owner}/${name}/releases/${releaseId}/assets?name=${encodeURIComponent(assetName)}`;
     const body = readFileSync(filePath);
     const response = await fetch(url, {
-        method : "POST",
-        headers : {
+        method: "POST",
+        headers: {
             ...githubHeaders(token),
-            "Content-Type" : "application/octet-stream",
-            "Content-Length" : String(body.length),
+            "Content-Type": "application/octet-stream",
+            "Content-Length": String(body.length),
         },
         body,
     });
     const text = await response.text();
-    if(response.ok){
+    if (response.ok) {
         return;
     }
-    if(response.status === 422 && text.includes("already_exists")){
+    if (response.status === 422 && text.includes("already_exists")) {
         console.log(`release: skip ${assetName} (already uploaded)`);
         return;
     }
     throw new Error(`GitHub upload ${response.status}: ${text}`);
 }
 
-function githubHeaders(token : string) : Record<string, string>{
+function githubHeaders(token: string): Record < string, string > {
     return {
-        Accept : "application/vnd.github+json",
-        Authorization : `Bearer ${token}`,
-        "User-Agent" : USER_AGENT,
-        "X-GitHub-Api-Version" : "2022-11-28",
+        Accept: "application/vnd.github+json",
+        Authorization: `Bearer ${token}`,
+        "User-Agent": USER_AGENT,
+        "X-GitHub-Api-Version": "2022-11-28",
     };
 }
 
-function git(cwd : string, args : string[]) : void {
-    const result = spawnSync("git", args, { cwd, stdio : "inherit" });
-    if(result.status!== 0){
+function git(cwd: string, args: string[]): void {
+    const result = spawnSync("git", args, { cwd, stdio: "inherit" });
+    if (result.status !== 0) {
         throw new Error(`git ${args.join(" ")} failed`);
     }
 }

package/src/cli/workspace.ts

@@ -4,22 +4,22 @@ import { join, resolve } from "node:path";
 import { detectProjectLayout } from "../config/detectProject.js";
 
 export type WorkspacePackage = {
-    name : string;
-    version : string;
-    dir : string;
-    manifestPath : string;
-    private : boolean;
-    manifest : PackageManifest;
+    name: string;
+    version: string;
+    dir: string;
+    manifestPath: string;
+    private: boolean;
+    manifest: PackageManifest;
 };
 
 export type PackageManifest = {
-    name : string;
-    version : string;
-    private ? : boolean;
-    dependencies ? : Record<string, string>;
-    devDependencies ? : Record<string, string>;
-    optionalDependencies ? : Record<string, string>;
-    peerDependencies ? : Record<string, string>;
+    name: string;
+    version: string;
+    private?: boolean;
+    dependencies?: Record < string, string > ;
+    devDependencies?: Record < string, string > ;
+    optionalDependencies?: Record < string, string > ;
+    peerDependencies?: Record < string, string > ;
 };
 
 const DEPENDENCY_FIELDS = [
@@ -29,68 +29,68 @@ const DEPENDENCY_FIELDS = [
     "peerDependencies",
 ]as const;
 
-export function findWorkspaceRoot(cwd : string) : string {
+export function findWorkspaceRoot(cwd: string): string {
     const layout = detectProjectLayout(cwd);
     const candidates = [layout.root, resolve(cwd)];
-    for(const candidate of candidates){
+    for (const candidate of candidates) {
         const crates = join(candidate, "projects", "crates");
         const packages = join(candidate, "projects", "packages");
-        if(existsSync(crates) && existsSync(packages)){
+        if (existsSync(crates) && existsSync(packages)) {
             return candidate;
         }
     }
     throw new Error("could not find Nifty workspace (expected projects/crates and projects/packages)");
 }
 
-export function listWorkspacePackages(root : string) : WorkspacePackage[]{
+export function listWorkspacePackages(root: string): WorkspacePackage[] {
     const packagesDir = join(root, "projects", "packages");
-    if(!existsSync(packagesDir)){
+    if (!existsSync(packagesDir)) {
         return[];
     }
 
-    const packages : WorkspacePackage[] = [];
-    for(const entry of readdirSync(packagesDir, { withFileTypes : true })){
-        if(!entry.isDirectory() || entry.name === "node_modules"){
+    const packages: WorkspacePackage[] = [];
+    for (const entry of readdirSync(packagesDir, { withFileTypes: true })) {
+        if (!entry.isDirectory() || entry.name === "node_modules") {
             continue;
         }
         const manifestPath = join(packagesDir, entry.name, "package.json");
-        if(!existsSync(manifestPath)){
+        if (!existsSync(manifestPath)) {
             continue;
         }
         const manifest = JSON.parse(readFileSync(manifestPath, "utf8"))as PackageManifest;
-        if(!manifest.name || !manifest.version){
+        if (!manifest.name || !manifest.version) {
             throw new Error(`package.json missing name or version: ${manifestPath}`);
         }
         packages.push({
-            name : manifest.name,
-            version : manifest.version,
-            dir : join(packagesDir, entry.name),
+            name: manifest.name,
+            version: manifest.version,
+            dir: join(packagesDir, entry.name),
             manifestPath,
-            private : manifest.private === true,
+            private: manifest.private === true,
             manifest,
         });
     }
 
-    return packages.sort((a, b) =>a.name.localeCompare(b.name));
+    return packages.sort((a, b) => a.name.localeCompare(b.name));
 }
 
 export function collectInternalDependencyNames(
-    pkg : WorkspacePackage,
-    byName : Map<string, WorkspacePackage>,
-) : Set<string>{
-    const deps = new Set<string>();
-    for(const field of DEPENDENCY_FIELDS){
+    pkg: WorkspacePackage,
+    byName: Map < string, WorkspacePackage > ,
+): Set < string> {
+    const deps = new Set < string> ();
+    for (const field of DEPENDENCY_FIELDS) {
         const entries = pkg.manifest[field];
-        if(!entries){
+        if (!entries) {
             continue;
         }
-        for(const[depName, spec]of Object.entries(entries)){
-            if(byName.has(depName)){
+        for (const[depName, spec]of Object.entries(entries)) {
+            if (byName.has(depName)) {
                 deps.add(depName);
                 continue;
             }
             const resolved = resolveWorkspaceDependencyName(spec, pkg.dir, byName);
-            if(resolved){
+            if (resolved) {
                 deps.add(resolved);
             }
         }
@@ -99,24 +99,24 @@ export function collectInternalDependencyNames(
 }
 
 function resolveWorkspaceDependencyName(
-    spec : string,
-    packageDir : string,
-    byName : Map<string, WorkspacePackage>,
-) : string | undefined {
-    if(spec.startsWith("workspace:")){
+    spec: string,
+    packageDir: string,
+    byName: Map < string, WorkspacePackage > ,
+): string | undefined {
+    if (spec.startsWith("workspace:")) {
         return undefined;
     }
-    if(!spec.startsWith("file:")){
+    if (!spec.startsWith("file:")) {
         return undefined;
     }
     const targetDir = resolve(packageDir, spec.slice("file:".length));
-    for(const candidate of byName.values()){
-        if(candidate.dir === targetDir){
+    for (const candidate of byName.values()) {
+        if (candidate.dir === targetDir) {
             return candidate.name;
         }
     }
     const manifestPath = join(targetDir, "package.json");
-    if(!existsSync(manifestPath)){
+    if (!existsSync(manifestPath)) {
         return undefined;
     }
     const manifest = JSON.parse(readFileSync(manifestPath, "utf8"))as PackageManifest;

package/src/config/authorMap.ts

@@ -7,19 +7,15 @@ import type { NiftyConfig } from "./types.js";
 export const DEFAULT_AUTHOR_MAP_PATH = "documentation/maintenance/author-github.json";
 
 /** Resolve configured author map path to an absolute filesystem path. */
-export function resolveAuthorMapPath(config : NiftyConfig, repoRoot : string) : string {
+export function resolveAuthorMapPath(config: NiftyConfig, repoRoot: string): string {
     const configured = config.authorMap ?? DEFAULT_AUTHOR_MAP_PATH;
     return isAbsolute(configured) ? configured : join(repoRoot, configured);
 }
 
 /** Load author map file contents for native helpers expecting JSON text. */
-export function loadAuthorMapJson(repoRoot : string, authorMapPath ? : string) : string {
-    const abs = authorMapPath
-        ? isAbsolute(authorMapPath)
-            ? authorMapPath
-            : join(repoRoot, authorMapPath)
-        : resolveAuthorMapPath({ }, repoRoot);
-    if(!existsSync(abs)){
+export function loadAuthorMapJson(repoRoot: string, authorMapPath?: string) : string {
+    const abs = authorMapPath ? isAbsolute(authorMapPath) ? authorMapPath : join(repoRoot, authorMapPath) : resolveAuthorMapPath({ }, repoRoot);
+    if (!existsSync(abs)) {
         return "{}";
     }
     return readFileSync(abs, "utf8");

package/src/config/defineConfig.ts

@@ -1,12 +1,12 @@
 import type { NiftyConfig, NiftyConfigEnv } from "./types.js";
 
 /** Type-safe helper for `nifty.config.ts` / `nifty.config.js`. */
-export function defineConfig(config : NiftyConfig) : NiftyConfig;
+export function defineConfig(config: NiftyConfig): NiftyConfig;
 export function defineConfig(
-    config : (env : NiftyConfigEnv) =>NiftyConfig | Promise<NiftyConfig>,
-) : (env : NiftyConfigEnv) =>NiftyConfig | Promise<NiftyConfig>;
+    config: (env: NiftyConfigEnv) => NiftyConfig | Promise < NiftyConfig> ,
+): (env: NiftyConfigEnv) => NiftyConfig | Promise < NiftyConfig> ;
 export function defineConfig(
-    config : NiftyConfig | ((env : NiftyConfigEnv) =>NiftyConfig | Promise<NiftyConfig>),
-) : NiftyConfig | ((env : NiftyConfigEnv) =>NiftyConfig | Promise<NiftyConfig>){
+    config: NiftyConfig | ((env: NiftyConfigEnv) => NiftyConfig | Promise < NiftyConfig> ),
+): NiftyConfig | ((env: NiftyConfigEnv) => NiftyConfig | Promise < NiftyConfig> ) {
     return config;
 }