@netlify/build-info 6.2.1 → 6.2.3-rc.1

package/lib/src/frameworks/angular.d.ts

@@ -0,0 +1,24 @@
+import { BaseFramework, Category, Framework } from './framework.js';
+export declare class Angular extends BaseFramework implements Framework {
+    id: string;
+    name: string;
+    configFiles: string[];
+    npmDependencies: string[];
+    category: Category;
+    dev: {
+        port: number;
+        command: string;
+        pollingStrategies: {
+            name: string;
+        }[];
+    };
+    build: {
+        command: string;
+        directory: string;
+    };
+    logo: {
+        default: string;
+        light: string;
+        dark: string;
+    };
+}

package/lib/src/frameworks/angular.js

@@ -0,0 +1,22 @@
+import { BaseFramework, Category } from './framework.js';
+export class Angular extends BaseFramework {
+    id = 'angular';
+    name = 'Angular';
+    configFiles = ['angular.json'];
+    npmDependencies = ['@angular/cli'];
+    category = Category.FrontendFramework;
+    dev = {
+        port: 4200,
+        command: 'ng serve',
+        pollingStrategies: [{ name: 'TCP' }, { name: 'HTTP' }],
+    };
+    build = {
+        command: 'ng build --prod',
+        directory: 'dist/',
+    };
+    logo = {
+        default: '/logos/angular/default.svg',
+        light: '/logos/angular/default.svg',
+        dark: '/logos/angular/default.svg',
+    };
+}

package/lib/src/frameworks/assemble.d.ts

@@ -0,0 +1,16 @@
+import { BaseFramework, Category, Framework } from './framework.js';
+export declare class Assemble extends BaseFramework implements Framework {
+    id: string;
+    name: string;
+    npmDependencies: string[];
+    category: Category;
+    build: {
+        command: string;
+        directory: string;
+    };
+    logo: {
+        default: string;
+        light: string;
+        dark: string;
+    };
+}

package/lib/src/frameworks/assemble.js

@@ -0,0 +1,16 @@
+import { BaseFramework, Category } from './framework.js';
+export class Assemble extends BaseFramework {
+    id = 'assemble';
+    name = 'Assemble';
+    npmDependencies = ['assemble'];
+    category = Category.SSG;
+    build = {
+        command: 'grunt build',
+        directory: 'dist',
+    };
+    logo = {
+        default: '/logos/assemble/default.svg',
+        light: '/logos/assemble/default.svg',
+        dark: '/logos/assemble/default.svg',
+    };
+}

package/lib/src/frameworks/astro.d.ts

@@ -0,0 +1,25 @@
+import { BaseFramework, Category, Framework } from './framework.js';
+export declare class Astro extends BaseFramework implements Framework {
+    id: string;
+    name: string;
+    configFiles: string[];
+    npmDependencies: string[];
+    category: Category;
+    staticAssetsDirectory: string;
+    dev: {
+        port: number;
+        command: string;
+        pollingStrategies: {
+            name: string;
+        }[];
+    };
+    build: {
+        command: string;
+        directory: string;
+    };
+    logo: {
+        default: string;
+        light: string;
+        dark: string;
+    };
+}

package/lib/src/frameworks/astro.js

@@ -0,0 +1,23 @@
+import { BaseFramework, Category } from './framework.js';
+export class Astro extends BaseFramework {
+    id = 'astro';
+    name = 'Astro';
+    configFiles = ['astro.config.mjs'];
+    npmDependencies = ['astro'];
+    category = Category.SSG;
+    staticAssetsDirectory = 'public';
+    dev = {
+        port: 3000,
+        command: 'astro dev',
+        pollingStrategies: [{ name: 'TCP' }, { name: 'HTTP' }],
+    };
+    build = {
+        command: 'astro build',
+        directory: 'dist',
+    };
+    logo = {
+        default: '/logos/astro/light.svg',
+        light: '/logos/astro/light.svg',
+        dark: '/logos/astro/dark.svg',
+    };
+}

package/lib/src/frameworks/blitz.d.ts

@@ -0,0 +1,23 @@
+import { BaseFramework, Category, Framework } from './framework.js';
+export declare class Blitz extends BaseFramework implements Framework {
+    id: string;
+    name: string;
+    npmDependencies: string[];
+    category: Category;
+    dev: {
+        command: string;
+        port: number;
+        pollingStrategies: {
+            name: string;
+        }[];
+    };
+    build: {
+        command: string;
+        directory: string;
+    };
+    logo: {
+        default: string;
+        light: string;
+        dark: string;
+    };
+}

package/lib/src/frameworks/blitz.js

@@ -0,0 +1,21 @@
+import { BaseFramework, Category } from './framework.js';
+export class Blitz extends BaseFramework {
+    id = 'blitz';
+    name = 'Blitz.js';
+    npmDependencies = ['blitz'];
+    category = Category.SSG;
+    dev = {
+        command: 'blitz dev',
+        port: 3000,
+        pollingStrategies: [{ name: 'TCP' }],
+    };
+    build = {
+        command: 'blitz build',
+        directory: 'out',
+    };
+    logo = {
+        default: '/logos/blitz/light.svg',
+        light: '/logos/blitz/light.svg',
+        dark: '/logos/blitz/dark.svg',
+    };
+}

package/lib/src/frameworks/brunch.d.ts

@@ -0,0 +1,24 @@
+import { BaseFramework, Category, Framework } from './framework.js';
+export declare class Brunch extends BaseFramework implements Framework {
+    id: string;
+    name: string;
+    npmDependencies: string[];
+    configFiles: string[];
+    category: Category;
+    dev: {
+        command: string;
+        port: number;
+        pollingStrategies: {
+            name: string;
+        }[];
+    };
+    build: {
+        command: string;
+        directory: string;
+    };
+    logo: {
+        default: string;
+        light: string;
+        dark: string;
+    };
+}

package/lib/src/frameworks/brunch.js

@@ -0,0 +1,22 @@
+import { BaseFramework, Category } from './framework.js';
+export class Brunch extends BaseFramework {
+    id = 'brunch';
+    name = 'Brunch';
+    npmDependencies = ['brunch'];
+    configFiles = ['brunch-config.js'];
+    category = Category.BuildTool;
+    dev = {
+        command: 'brunch watch --server',
+        port: 3333,
+        pollingStrategies: [{ name: 'TCP' }, { name: 'HTTP' }],
+    };
+    build = {
+        command: 'brunch build',
+        directory: 'public',
+    };
+    logo = {
+        default: '/logos/brunch/default.svg',
+        light: '/logos/brunch/default.svg',
+        dark: '/logos/brunch/default.svg',
+    };
+}

package/lib/src/frameworks/cecil.d.ts

@@ -0,0 +1,23 @@
+import { BaseFramework, Category, Framework } from './framework.js';
+export declare class Cecil extends BaseFramework implements Framework {
+    id: string;
+    name: string;
+    configFiles: string[];
+    category: Category;
+    dev: {
+        command: string;
+        port: number;
+        pollingStrategies: {
+            name: string;
+        }[];
+    };
+    build: {
+        command: string;
+        directory: string;
+    };
+    logo: {
+        default: string;
+        light: string;
+        dark: string;
+    };
+}

package/lib/src/frameworks/cecil.js

@@ -0,0 +1,21 @@
+import { BaseFramework, Category } from './framework.js';
+export class Cecil extends BaseFramework {
+    id = 'cecil';
+    name = 'Cecil';
+    configFiles = ['config.yml'];
+    category = Category.SSG;
+    dev = {
+        command: 'cecil serve',
+        port: 8000,
+        pollingStrategies: [{ name: 'TCP' }, { name: 'HTTP' }],
+    };
+    build = {
+        command: 'cecil build',
+        directory: '_site',
+    };
+    logo = {
+        default: '/logos/cecil/default.svg',
+        light: '/logos/cecil/default.svg',
+        dark: '/logos/cecil/default.svg',
+    };
+}

package/lib/src/frameworks/docpad.d.ts

@@ -0,0 +1,18 @@
+import { BaseFramework, Category, Framework } from './framework.js';
+export declare class DocPad extends BaseFramework implements Framework {
+    id: string;
+    name: string;
+    npmDependencies: string[];
+    category: Category;
+    dev: {
+        command: string;
+        port: number;
+        pollingStrategies: {
+            name: string;
+        }[];
+    };
+    build: {
+        command: string;
+        directory: string;
+    };
+}

package/lib/src/frameworks/docpad.js

@@ -0,0 +1,16 @@
+import { BaseFramework, Category } from './framework.js';
+export class DocPad extends BaseFramework {
+    id = 'docpad';
+    name = 'DocPad';
+    npmDependencies = ['docpad'];
+    category = Category.SSG;
+    dev = {
+        command: 'docpad run',
+        port: 9778,
+        pollingStrategies: [{ name: 'TCP' }, { name: 'HTTP' }],
+    };
+    build = {
+        command: 'docpad generate',
+        directory: 'out',
+    };
+}

package/lib/src/frameworks/docusaurus.d.ts

@@ -0,0 +1,30 @@
+import { BaseFramework, Category, Framework, VerboseDetection } from './framework.js';
+export declare class Docusaurus extends BaseFramework implements Framework {
+    id: string;
+    name: string;
+    configFiles: string[];
+    npmDependencies: string[];
+    category: Category;
+    staticAssetsDirectory: string;
+    dev: {
+        command: string;
+        port: number;
+        pollingStrategies: {
+            name: string;
+        }[];
+    };
+    build: {
+        command: string;
+        directory: string;
+    };
+    logo: {
+        default: string;
+        light: string;
+        dark: string;
+    };
+    env: {
+        BROWSER: string;
+    };
+    detect(): any;
+    isV1(detected: VerboseDetection): boolean;
+}

package/lib/src/frameworks/docusaurus.js

@@ -0,0 +1,44 @@
+import { BaseFramework, Category } from './framework.js';
+export class Docusaurus extends BaseFramework {
+    id = 'docusaurus';
+    name = 'Docusaurus';
+    configFiles = [
+        'docusaurus.config.js',
+        'siteConfig.js', // v1
+    ];
+    npmDependencies = [
+        '@docusaurus/core',
+        'docusaurus', // v1
+    ];
+    category = Category.SSG;
+    staticAssetsDirectory = 'static';
+    dev = {
+        command: 'docusaurus start',
+        port: 3000,
+        pollingStrategies: [{ name: 'TCP' }, { name: 'HTTP' }],
+    };
+    build = {
+        command: 'docusaurus build',
+        directory: 'build',
+    };
+    logo = {
+        default: '/logos/docusaurus/default.svg',
+        light: '/logos/docusaurus/default.svg',
+        dark: '/logos/docusaurus/default.svg',
+    };
+    env = { BROWSER: 'none' };
+    async detect() {
+        const detected = await super.detect(true);
+        if (detected) {
+            if (this.isV1(detected)) {
+                this.build.command = 'docusaurus-build';
+                this.build.directory = 'build/<project-name>';
+                this.dev.command = 'docusaurus-start';
+            }
+            return this;
+        }
+    }
+    isV1(detected) {
+        return detected.config?.endsWith('siteConfig.js') || detected.npmDependency?.name === 'docusaurus';
+    }
+}

package/lib/src/frameworks/eleventy.d.ts

@@ -0,0 +1,24 @@
+import { BaseFramework, Category, Framework } from './framework.js';
+export declare class Eleventy extends BaseFramework implements Framework {
+    id: string;
+    name: string;
+    configFiles: string[];
+    npmDependencies: string[];
+    category: Category;
+    dev: {
+        command: string;
+        port: number;
+        pollingStrategies: {
+            name: string;
+        }[];
+    };
+    build: {
+        command: string;
+        directory: string;
+    };
+    logo: {
+        default: string;
+        light: string;
+        dark: string;
+    };
+}

package/lib/src/frameworks/eleventy.js

@@ -0,0 +1,22 @@
+import { BaseFramework, Category } from './framework.js';
+export class Eleventy extends BaseFramework {
+    id = 'eleventy';
+    name = 'Eleventy';
+    configFiles = ['.eleventy.js', 'eleventy.config.js', 'eleventy.config.cjs'];
+    npmDependencies = ['@11ty/eleventy'];
+    category = Category.SSG;
+    dev = {
+        command: 'eleventy --serve',
+        port: 8080,
+        pollingStrategies: [{ name: 'TCP' }, { name: 'HTTP' }],
+    };
+    build = {
+        command: 'eleventy',
+        directory: '_site',
+    };
+    logo = {
+        default: '/logos/eleventy/default.svg',
+        light: '/logos/eleventy/default.svg',
+        dark: '/logos/eleventy/default.svg',
+    };
+}

package/lib/src/frameworks/ember.d.ts

@@ -0,0 +1,24 @@
+import { BaseFramework, Category, Framework } from './framework.js';
+export declare class Ember extends BaseFramework implements Framework {
+    id: string;
+    name: string;
+    configFiles: string[];
+    npmDependencies: string[];
+    category: Category;
+    dev: {
+        command: string;
+        port: number;
+        pollingStrategies: {
+            name: string;
+        }[];
+    };
+    build: {
+        command: string;
+        directory: string;
+    };
+    logo: {
+        default: string;
+        light: string;
+        dark: string;
+    };
+}

package/lib/src/frameworks/ember.js

@@ -0,0 +1,22 @@
+import { BaseFramework, Category } from './framework.js';
+export class Ember extends BaseFramework {
+    id = 'ember';
+    name = 'Ember.js';
+    configFiles = ['ember-cli-build.js'];
+    npmDependencies = ['ember-cli'];
+    category = Category.FrontendFramework;
+    dev = {
+        command: 'ember serve',
+        port: 4200,
+        pollingStrategies: [{ name: 'TCP' }, { name: 'HTTP' }],
+    };
+    build = {
+        command: 'ember build',
+        directory: 'dist',
+    };
+    logo = {
+        default: '/logos/ember/default.svg',
+        light: '/logos/ember/light.svg',
+        dark: '/logos/ember/dark.svg',
+    };
+}

package/lib/src/frameworks/expo.d.ts

@@ -0,0 +1,24 @@
+import { BaseFramework, Category, Framework } from './framework.js';
+export declare class Expo extends BaseFramework implements Framework {
+    id: string;
+    name: string;
+    configFiles: string[];
+    npmDependencies: string[];
+    category: Category;
+    dev: {
+        command: string;
+        port: number;
+        pollingStrategies: {
+            name: string;
+        }[];
+    };
+    build: {
+        command: string;
+        directory: string;
+    };
+    logo: {
+        default: string;
+        light: string;
+        dark: string;
+    };
+}

package/lib/src/frameworks/expo.js

@@ -0,0 +1,22 @@
+import { BaseFramework, Category } from './framework.js';
+export class Expo extends BaseFramework {
+    id = 'expo';
+    name = 'Expo';
+    configFiles = ['app.json'];
+    npmDependencies = ['expo'];
+    category = Category.FrontendFramework;
+    dev = {
+        command: 'expo start --web',
+        port: 19006,
+        pollingStrategies: [{ name: 'TCP' }, { name: 'HTTP' }],
+    };
+    build = {
+        command: 'expo build:web',
+        directory: 'web-build',
+    };
+    logo = {
+        default: '/logos/expo/default.svg',
+        light: '/logos/expo/light.svg',
+        dark: '/logos/expo/dark.svg',
+    };
+}

package/lib/src/frameworks/framework.d.ts

@@ -0,0 +1,84 @@
+import type { PackageJson } from 'read-pkg';
+import { SemVer } from 'semver';
+import { Project } from '../project.js';
+export declare enum Category {
+    FrontendFramework = "frontend_framework",
+    SSG = "static_site_generator",
+    BuildTool = "build_tool"
+}
+export type PollingStrategy = {
+    name: any;
+};
+export interface Framework {
+    project: Project;
+    id: string;
+    name: string;
+    category: Category;
+    configFiles: string[];
+    npmDependencies: string[];
+    excludedNpmDependencies?: string[];
+    version?: SemVer;
+    staticAssetsDirectory?: string;
+    dev?: {
+        command: string;
+        port?: number;
+        pollingStrategies?: PollingStrategy[];
+    };
+    build: {
+        command: string;
+        directory: string;
+    };
+    logo?: {
+        default: string;
+        light?: string;
+        dark?: string;
+    };
+    plugins: string[];
+    env: Record<string, string>;
+    detect(): Promise<Framework | undefined>;
+}
+export type VerboseDetection = {
+    npmDependency?: {
+        name: string;
+        version?: SemVer;
+    };
+    config?: string;
+};
+export declare abstract class BaseFramework {
+    /** The current project inside we want to detect the framework */
+    project: Project;
+    /** The location where the framework got detected */
+    path?: string | undefined;
+    id: string;
+    name: string;
+    category: Category;
+    version?: SemVer;
+    configFiles: string[];
+    npmDependencies: string[];
+    excludedNpmDependencies: string[];
+    plugins: string[];
+    env: {};
+    constructor(
+    /** The current project inside we want to detect the framework */
+    project: Project, 
+    /** The location where the framework got detected */
+    path?: string | undefined);
+    /** check if the npmDependencies are used inside the provided package.json */
+    protected npmDependenciesUsed(pkgJSON: PackageJson): {
+        name: string;
+        version?: SemVer;
+    } | undefined;
+    /**
+     * Checks if the project is using a specific framework:
+     * - if `npmDependencies` is set, one of them must be present in then `package.json` `dependencies|devDependencies`
+     * - if `excludedNpmDependencies` is set, none of them must be present in the `package.json` `dependencies|devDependencies`
+     * - if `configFiles` is set, one of the files must exist
+     */
+    detect(): Promise<this | undefined>;
+    detect(verbose: true): Promise<VerboseDetection | undefined>;
+    /** This method will be called by the JSON.stringify */
+    toJSON(): {
+        name: string;
+        id: string;
+    };
+}