framework info

Важное уведомление

Этот репозиторий был перемещен в монорепозиторий github.com/netlify/build. Имя пакета и версии сохраняются!

Утилита обнаружения фреймворка.

Определяет, какую платформу использует конкретный веб-сайт. Также возвращаются команды сборки/разработки платформы, каталоги и порт сервера.

Обнаружены следующие фреймворки:

• Генераторы статических сайтов: Gatsby, Hugo, Jekyll, Next.js, Nuxt, Hexo, Gridsome, Docusaurus, Eleventy, Middleman, Phenomic, React-static, Stencil, Vuepress, Assemble, DocPad, Harp, Metalsmith, Roots, Wintersmith
• Фронтенд-фреймворки: create-react-app, Vue, Sapper, Angular, Ember, Svelte, Expo, Quasar.
• Инструменты сборки: Parcel, Brunch, Grunt, Gulp.

Если вы ищете способ запустить framework-info через CLI, проверьте проект build-info .

Дополнения и обновления приветствуются!

Пример (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: []
// }

Установка

npm install @netlify/framework-info

Использование (Node.js)

listFrameworks (варианты?)

options : object?
Возвращаемое значение : Promise<object[]>

Параметры

директор проекта

Тип : string
Значение по умолчанию : process.cwd()

Путь к каталогу сайта.

Возвращаемое значение

Это возвращает Promise , разрешающее массив объектов, описывающих каждую структуру. Массив может быть пустым, содержать один или несколько объектов.

Каждый объект имеет следующие свойства.

идентификатор

Тип : string

Я, например, "gatsby" .

имя

Тип : string

Имя фреймворка, например "Gatsby" .

категория

Тип : string

Категория среди "static_site_generator" , "frontend_framework" и "build_tool" .

разработчик

Тип : object

Информация о команде dev.

команды

Тип : string[]

Команда разработчиков. Альтернатив может быть несколько.

порт

Тип : number

Порт сервера.

стратегии опросов

Тип : object[]

Стратегии опроса, которые следует использовать при проверке готовности сервера разработки.

строить

Тип : object

Информация о команде сборки.

команды

Тип : string[]

Команда сборки. Альтернатив может быть несколько.

каталог

Тип : string

Относительный путь к каталогу, в котором создаются файлы.

staticAssetsDirectory

Тип : string

Каталог, в котором платформа хранит статические ресурсы. Может быть undefined .

окружение

Тип : object

Переменные среды, которые следует установить при вызове команды dev.

плагины

Тип : string[]

Список рекомендуемых плагинов сборки Netlify для установки для платформы.

hasFramework (frameworkId, параметры?)

options : object?
Возвращаемое значение : Promise<boolean>

То же, что и listFramework() за исключением конкретной платформы и возвращает логическое значение.

getFramework (frameworkId, параметры?)

options : object?
Возвращаемое значение : Promise<object>

То же, что и listFramework() за исключением того, что платформа передается в качестве аргумента, а не обнаруживается. Возвращается один объект платформы.

Использование (CLI)

$ framework-info [projectDirectory]

Это печатает идентификаторы каждой структуры.

Если известное найдено, выводится unknown .

Доступные флаги:

• --long : показать дополнительную информацию о каждой платформе. Результатом будет массив JSON.

Добавьте или обновите фреймворк

Каждая платформа представляет собой файл JSON в каталоге /src/frameworks/ . Например:

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

Все свойства обязательны.

идентификатор

Тип : string

Идентификатор фреймворка.

имя

Тип : string

Имя фреймворка.

категория

Тип : string

Один из "static_site_generator" , "frontend_framework" или "build_tool" .

обнаружить

Тип : object

Информация, используемая для обнаружения этой структуры

npmЗависимости

Тип : string[]

Пакеты npm Framework. Любой проект с одним из этих пакетов в package.json ( dependencies или devDependencies ) будет считаться использующим эту платформу.

Если пусто, это игнорируется.

исключенныеNpmDependities

Тип : string[]

Инверсия npmDependencies . Если какой-либо проект использует один из этих пакетов, он не будет считаться использующим платформу.

Если пусто, это игнорируется.

файлы конфигурации

Тип : string[]

Файлы конфигурации Framework. Это должны быть пути относительно каталога проекта. Любой проект с одним из файлов конфигурации будет рассматриваться как использующий платформу.

Если пусто, это игнорируется.

разработчик

Тип : object

Параметры для обнаружения команды dev.

команда

Тип : string

Команда разработчика по умолчанию.

порт

Тип : number

Порт локального сервера разработки.

стратегии опросов

Тип : object[]

Стратегии опроса, которые следует использовать при проверке готовности сервера разработки.

строить

Тип : object

Параметры для обнаружения команды сборки.

команда

Тип : string

Команда сборки по умолчанию.

каталог

Тип : string

Каталог, в который записываются построенные файлы.

staticAssetsDirectory

Тип : string

Каталог, в котором платформа хранит статические ресурсы, необходимые для платформы.

окружение

Тип : object

Переменные среды, которые следует установить при запуске команды dev.

плагины

Тип : object[]

Список названий и условий пакетов плагинов сборки Netlify. Если для плагина выполнено условие, он будет возвращен в список плагинов платформы.

Например

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