framework info

Wichtiger Hinweis

Dieses Repository wurde in das Mono-Repository von github.com/netlify/build verschoben. Der Paketname und die Versionen bleiben erhalten!

Dienstprogramm zur Framework-Erkennung.

Erkennt, welches Framework eine bestimmte Website verwendet. Die Build/Dev-Befehle, Verzeichnisse und der Server-Port des Frameworks werden ebenfalls zurückgegeben.

Folgende Frameworks werden erkannt:

• Statische Site-Generatoren: Gatsby, Hugo, Jekyll, Next.js, Nuxt, Hexo, Gridsome, Docusaurus, Eleventy, Middleman, Phenomic, React-static, Schablone, Vuepress, Assemble, DocPad, Harp, Metalsmith, Roots, Wintersmith
• Front-End-Frameworks: Create-React-App, Vue, Sapper, Angular, Ember, Svelte, Expo, Quasar
• Build-Tools: Parcel, Brunch, Grunt, Gulp

Wenn Sie nach einer Möglichkeit suchen, framework-info über die CLI auszuführen, schauen Sie sich das build-info -Projekt an.

Ergänzungen und Aktualisierungen sind willkommen!

Beispiel (Node.js)

 import { listFrameworks , hasFramework , getFramework } from '@netlify/framework-info'

console . log ( await listFrameworks ( { projectDir : './path/to/gatsby/website' } ) )
// [
//   {
//     id: 'gatsby',
//     name: 'Gatsby',
//     category: 'static_site_generator',
//     dev: {
//       commands: ['gatsby develop'],
//       port: 8000,
//       pollingStrategies: [{ name: 'TCP' }, { name: 'HTTP' }]
//     },
//     build: {
//       commands: ['gatsby build'],
//       directory: 'public'
//     },
//     staticAssetsDirectory: "static",
//     env: { GATSBY_LOGGER: 'yurnalist' },
//     plugins: []
//   }
// ]

console . log ( await listFrameworks ( { projectDir : './path/to/vue/website' } ) )
// [
//   {
//     id: 'vue',
//     name: 'Vue.js',
//     category: 'frontend_framework',
//     dev: {
//       commands: ['npm run serve'],
//       port: 8080,
//       pollingStrategies: [{ name: 'TCP' }, { name: 'HTTP' }]
//     },
//     build: {
//       commands: ['vue-cli-service build'],
//       directory: 'dist'
//     },
//     env: {},
//     plugins: []
//   }
// ]

console . log ( await hasFramework ( 'vue' , { projectDir : './path/to/vue/website' } ) )
// true

console . log ( await getFramework ( 'vue' , { projectDir : './path/to/vue/website' } ) )
// {
//   id: 'vue',
//   name: 'Vue.js',
//   category: 'frontend_framework',
//   dev: {
//     commands: ['npm run serve'],
//     port: 8080,
//     pollingStrategies: [{ name: 'TCP' }, { name: 'HTTP' }]
//   },
//   build: {
//     commands: ['vue-cli-service build'],
//     directory: 'dist'
//   },
//   env: {},
//   plugins: []
// }

Installation

npm install @netlify/framework-info

Verwendung (Node.js)

listFrameworks(Optionen?)

options : object?
Rückgabewert : Promise<object[]>

Optionen

Projektverzeichnis

Typ : string
Standardwert : process.cwd()

Pfad zum Verzeichnis der Website.

Rückgabewert

Dies gibt ein Promise zurück, das in ein Array von Objekten aufgelöst wird, die jedes Framework beschreiben. Das Array kann leer sein, ein einzelnes Objekt oder mehrere Objekte enthalten.

Jedes Objekt verfügt über die folgenden Eigenschaften.

Ausweis

Typ : string

ID wie "gatsby" .

Name

Typ : string

Framework-Name wie "Gatsby" .

Kategorie

Typ : string

Kategorie zwischen "static_site_generator" , "frontend_framework" und "build_tool" .

Entwickler

Typ : object

Informationen zum dev-Befehl.

Befehle

Typ : string[]

Dev-Befehl. Möglicherweise gibt es mehrere Alternativen.

Hafen

Typ : number

Server-Port.

Umfragestrategien

Typ : object[]

Polling-Strategien zur Verwendung bei der Überprüfung, ob der Entwicklungsserver bereit ist.

bauen

Typ : object

Informationen zum Build-Befehl.

Befehle

Typ : string[]

Build-Befehl. Möglicherweise gibt es mehrere Alternativen.

Verzeichnis

Typ : string

Relativer Pfad zum Verzeichnis, in dem Dateien erstellt werden.

staticAssetsDirectory

Typ : string

Verzeichnis, in dem das Framework statische Assets speichert. Kann undefined sein.

env

Typ : object

Umgebungsvariablen, die beim Aufruf des dev-Befehls festgelegt werden sollten.

Plugins

Typ : string[]

Eine Liste empfohlener Netlify-Build-Plugins zur Installation für das Framework.

hasFramework(frameworkId, Optionen?)

options : object?
Rückgabewert : Promise<boolean>

Identisch mit listFramework() außer für ein bestimmtes Framework, und gibt einen booleschen Wert zurück.

getFramework(frameworkId, Optionen?)

options : object?
Rückgabewert : Promise<object>

Identisch mit listFramework() außer dass das Framework als Argument übergeben und nicht erkannt wird. Es wird ein einzelnes Framework-Objekt zurückgegeben.

Nutzung (CLI)

$ framework-info [projectDirectory]

Dadurch werden die IDs jedes Frameworks gedruckt.

Wenn „bekannt“ gefunden wird, wird unknown gedruckt.

Verfügbare Flaggen:

• --long : Weitere Informationen zu jedem Framework anzeigen. Die Ausgabe wird ein JSON-Array sein.

Fügen Sie ein Framework hinzu oder aktualisieren Sie es

Jedes Framework ist eine JSON-Datei im Verzeichnis /src/frameworks/ . Zum Beispiel:

{
  "id" : " gatsby " ,
  "name" : " Gatsby " ,
  "category" : " static_site_generator " ,
  "detect" : {
    "npmDependencies" : [ " gatsby " ],
    "excludedNpmDependencies" : [],
    "configFiles" : [ " gatsby-config.js " ]
  },
  "dev" : {
    "command" : " gatsby develop " ,
    "port" : 8000 ,
    "pollingStrategies" : [{ "name" : " TCP " }, { "name" : " HTTP " }]
  },
  "build" : {
    "command" : " gatsby build " ,
    "directory" : " public "
  },
  "staticAssetsDirectory" : " static " ,
  "env" : { "GATSBY_LOGGER" : " yurnalist " },
  "plugins" : []
}

Alle Eigenschaften sind erforderlich.

Ausweis

Typ : string

ID des Frameworks.

Name

Typ : string

Name des Frameworks.

Kategorie

Typ : string

Einer von "static_site_generator" , "frontend_framework" oder "build_tool" .

erkennen

Typ : object

Informationen, die zur Erkennung dieses Frameworks verwendet werden

npmDependencies

Typ : string[]

NPM-Pakete des Frameworks. Jedes Projekt mit einem dieser Pakete in seiner package.json ( dependencies oder devDependencies ) wird als das Framework verwendend betrachtet.

Wenn leer, wird dies ignoriert.

ausgeschlossenNpmAbhängigkeiten

Typ : string[]

Umkehrung von npmDependencies . Wenn ein Projekt eines dieser Pakete verwendet, wird nicht davon ausgegangen, dass es das Framework verwendet.

Wenn leer, wird dies ignoriert.

configFiles

Typ : string[]

Konfigurationsdateien des Frameworks. Dies sollten Pfade relativ zum Projektverzeichnis sein. Jedes Projekt mit einer der Konfigurationsdateien wird als das Framework verwendend betrachtet.

Wenn leer, wird dies ignoriert.

Entwickler

Typ : object

Parameter zum Erkennen des Dev-Befehls.

Befehl

Typ : string

Standard-Entwicklungsbefehl.

Hafen

Typ : number

Port des lokalen Entwicklungsservers.

Umfragestrategien

Typ : object[]

Polling-Strategien zur Verwendung bei der Überprüfung, ob der Entwicklungsserver bereit ist.

bauen

Typ : object

Parameter zum Erkennen des Build-Befehls.

Befehl

Typ : string

Standard-Build-Befehl.

Verzeichnis

Typ : string

Verzeichnis, in das erstellte Dateien geschrieben werden.

staticAssetsDirectory

Typ : string

Verzeichnis, in dem das Framework statische Assets speichert, sofern diese für das Framework relevant sind.

env

Typ : object

Umgebungsvariablen, die beim Ausführen des dev-Befehls festgelegt werden sollten.

Plugins

Typ : object[]

Eine Liste der Paketnamen und -bedingungen für Netlify-Build-Plugins. Wenn eine Bedingung für ein Plugin erfüllt ist, wird sie in der Plugin-Liste des Frameworks zurückgegeben.

Zum Beispiel

{
  "plugins" : [
    {
      "packageName" : " @netlify/plugin-nextjs " ,
      "condition" : { "minNodeVersion" : " 10.13.0 " }
    }
  ]
}