framework info

Pemberitahuan Penting

Repositori ini dipindahkan ke repositori mono github.com/netlify/build Nama paket dan versinya dipertahankan!

Utilitas deteksi kerangka kerja.

Mendeteksi kerangka kerja mana yang digunakan situs web tertentu. Perintah build/dev framework, direktori dan port server juga dikembalikan.

Kerangka kerja berikut terdeteksi:

• Generator situs statis: Gatsby, Hugo, Jekyll, Next.js, Nuxt, Hexo, Gridsome, Docusaurus, Eleventy, Middleman, Phenomic, React-static, Stencil, Vuepress, Assemble, DocPad, Harp, Metalsmith, Roots, Wintersmith
• Kerangka kerja front-end: buat-reaksi-aplikasi, Vue, Sapper, Angular, Ember, Svelte, Expo, Quasar
• Alat pembuatan: Parcel, Brunch, Grunt, Gulp

Jika Anda mencari cara untuk menjalankan framework-info melalui CLI, periksa proyek build-info .

Penambahan dan pembaruan dipersilakan!

Contoh (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: []
// }

Instalasi

npm install @netlify/framework-info

Penggunaan (Node.js)

daftarFrameworks(pilihan?)

options : object?
Nilai kembalian : Promise<object[]>

Pilihan

proyekDir

Jenis : string
Nilai default : process.cwd()

Jalur ke direktori situs web.

Nilai kembalian

Ini mengembalikan penyelesaian Promise ke array objek yang menjelaskan setiap kerangka kerja. Array bisa kosong, berisi satu objek atau beberapa objek.

Setiap objek memiliki properti berikut.

pengenal

Jenis : string

Id seperti "gatsby" .

nama

Jenis : string

Nama kerangka seperti "Gatsby" .

kategori

Jenis : string

Kategori di antara "static_site_generator" , "frontend_framework" dan "build_tool" .

dev

Jenis : object

Informasi tentang perintah dev.

perintah

Ketik : string[]

Perintah pengembang. Mungkin ada beberapa alternatif.

pelabuhan

Jenis : number

Pelabuhan server.

Strategi pemungutan suara

Ketik : object[]

Strategi polling yang digunakan saat memeriksa apakah server dev sudah siap.

membangun

Jenis : object

Informasi tentang perintah build.

perintah

Ketik : string[]

Membangun perintah. Mungkin ada beberapa alternatif.

direktori

Jenis : string

Jalur relatif ke direktori tempat file dibuat.

Direktori StaticAssets

Jenis : string

Direktori tempat kerangka kerja menyimpan aset statis. Bisa jadi undefined .

env

Jenis : object

Variabel lingkungan yang harus disetel saat memanggil perintah dev.

plugin

Ketik : string[]

Daftar rekomendasi plugin build Netlify untuk dipasang pada kerangka kerja tersebut.

hasFramework(frameworkId, opsi?)

options : object?
Nilai kembalian : Promise<boolean>

Sama seperti listFramework() kecuali hanya untuk kerangka kerja tertentu dan mengembalikan boolean.

getFramework(frameworkId, opsi?)

options : object?
Nilai kembalian : Promise<object>

Sama seperti listFramework() kecuali kerangka tersebut diteruskan sebagai argumen dan bukannya terdeteksi. Objek kerangka tunggal dikembalikan.

Penggunaan (CLI)

$ framework-info [projectDirectory]

Ini mencetak id setiap kerangka kerja.

Jika diketahui ditemukan, unknown dicetak.

Bendera yang tersedia:

• --long : Menampilkan informasi selengkapnya tentang setiap kerangka kerja. Outputnya akan berupa array JSON.

Tambahkan atau perbarui kerangka kerja

Setiap kerangka kerja adalah file JSON di direktori /src/frameworks/ . Misalnya:

{
  "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" : []
}

Semua properti diperlukan.

pengenal

Jenis : string

Id kerangka kerja.

nama

Jenis : string

Nama kerangka.

kategori

Jenis : string

Salah satu dari "static_site_generator" , "frontend_framework" atau "build_tool" .

mendeteksi

Jenis : object

Informasi yang digunakan untuk mendeteksi kerangka ini

npmDependensi

Ketik : string[]

Paket npm Framework. Proyek apa pun yang memiliki salah satu paket tersebut di package.json ( dependencies atau devDependencies ) akan dianggap menggunakan kerangka kerja tersebut.

Jika kosong, ini diabaikan.

dikecualikanNpmDependensi

Ketik : string[]

Kebalikan dari npmDependencies . Jika ada proyek yang menggunakan salah satu paket tersebut, maka proyek tersebut tidak akan dianggap menggunakan kerangka kerja tersebut.

Jika kosong, ini diabaikan.

configFiles

Ketik : string[]

File konfigurasi kerangka kerja. Itu harus berupa jalur yang berhubungan dengan direktori proyek. Setiap proyek dengan salah satu file konfigurasi akan dianggap menggunakan kerangka kerja tersebut.

Jika kosong, ini diabaikan.

dev

Jenis : object

Parameter untuk mendeteksi perintah dev.

memerintah

Jenis : string

Perintah pengembang default.

pelabuhan

Jenis : number

Port server pengembang lokal.

Strategi pemungutan suara

Ketik : object[]

Strategi polling yang digunakan saat memeriksa apakah server dev sudah siap.

membangun

Jenis : object

Parameter untuk mendeteksi perintah build.

memerintah

Jenis : string

Perintah pembuatan default.

direktori

Jenis : string

Direktori tempat file yang dibuat ditulis.

Direktori StaticAssets

Jenis : string

Direktori tempat kerangka kerja menyimpan aset statis jika relevan dengan kerangka kerja.

env

Jenis : object

Variabel lingkungan yang harus disetel saat menjalankan perintah dev.

plugin

Ketik : object[]

Daftar nama dan ketentuan paket plugin build Netlify. Jika suatu kondisi terpenuhi untuk sebuah plugin, maka kondisi tersebut akan dikembalikan dalam daftar plugin kerangka kerja.

Misalnya

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