Package Health Score

89 / 100

security
No known security issues
popularity
Popular
maintenance
Healthy
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
9.8.13	\|	05/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
9.8.10	\|	06/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
9.7.2	\|	02/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
8.0.2	\|	01/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
7.0.0	\|	12/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Popular

Weekly Downloads (107,424)

GitHub Stars: 218
Forks: 56
Contributors: 100

Direct Usage Popularity

The npm package @netlify/framework-info receives a total of 107,424 downloads a week. As such, we scored @netlify/framework-info popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package @netlify/framework-info, we found that it has been starred 218 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 100
Funding: No

With more than 10 contributors for the @netlify/framework-info repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 16
Open PR: 32
Last Release: 5 months ago
Last Commit: 4 days ago

Further analysis of the maintenance status of @netlify/framework-info based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @netlify/framework-info demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: ^14.14.0 || >=16.0.0

Age: 4 years
Dependencies: 10 Direct
Versions: 94
Install Size: 446 kB
Dist-tags: 7
# of Files: 27
Maintainers: 17
TS Typings: No

@netlify/framework-info has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Framework detection utility.

Detects which framework a specific website is using. The framework's build/dev commands, directories and server port are also returned.

The following frameworks are detected:

Static site generators: Gatsby, Hugo, Jekyll, Next.js, Nuxt, Hexo, Gridsome, Docusaurus, Eleventy, Middleman, Phenomic, React-static, Stencil, 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

If you're looking for a way to run framework-info via CLI check the build-info project.

Additions and updates are welcome!

Example (Node.js)

import { listFrameworks, hasFramework, getFramework, getFrameworkById } 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' }]
//     },
//     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' }]
//     },
//     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' }]
//   },
//   build: {
//     commands: ['vue-cli-service build'],
//     directory: 'dist'
//   },
//   env: {},
//   plugins: []
// }

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

Installation

npm install @netlify/framework-info

Usage (Node.js)

listFrameworks(options?)

options: object?
Return value: Promise

Options

projectDir

Type: string
Default value: process.cwd()

Path to the website's directory.

Return value

This returns a Promise resolving to an array of objects describing each framework. The array can be empty, contain a single object or several objects.

Each object has the following properties.

id

Type: string

Id such as "gatsby".

name

Type: string

Framework name such as "Gatsby".

dev

Type: object

Information about the dev command.

commands

Type: string[]

Dev command. There might be several alternatives.

port

Type: number

Server port.

pollingStrategies

Type: object[]

Polling strategies to use when checking if the dev server is ready.

build

Type: object

Information about the build command.

commands

Type: string[]

Build command. There might be several alternatives.

staticAssetsDirectory

Type: string

Directory where the framework stores static assets. Can be undefined.

env

Type: object

Environment variables that should be set when calling the dev command.

plugins

Type: string[]

A list of recommend Netlify build plugins to install for the framework.

hasFramework(frameworkId, options?)

options: object?
Return value: Promise

Same as listFramework() except only for a specific framework and returns a boolean.

getFramework(frameworkId, options?)

options: object?
Return value: Promise

Same as listFramework() except the framework is passed as argument instead of being detected. A single framework object is returned.

Usage (CLI)

$ framework-info [projectDirectory]

This prints the ids of each framework.

If known is found, unknown is printed.

Available flags:

--long: Show more information about each framework. The output will be a JSON array.

Add or update a framework

Each framework is a JSON file in the /src/frameworks/ directory. For example:

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

All properties are required.

id

Type: string

Id of the framework.

name

Type: string

Name of the framework.

detect

Type: object

Information used to detect this framework

npmDependencies

Type: string[]

Framework's npm packages. Any project with one of those packages in their package.json (dependencies or devDependencies) will be considered as using the framework.

If empty, this is ignored.

excludedNpmDependencies

Type: string[]

Inverse of npmDependencies. If any project is using one of those packages, it will not be considered as using the framework.

If empty, this is ignored.

configFiles

Type: string[]

Framework's configuration files. Those should be paths relative to the project's directory. Any project with one of configuration files will be considered as using the framework.

If empty, this is ignored.

dev

Type: object

Parameters to detect the dev command.

command

Type: string

Default dev command.

port

Type: number

Local dev server port.

pollingStrategies

Type: object[]

Polling strategies to use when checking if the dev server is ready.

build

Type: object

Parameters to detect the build command.

command

Type: string

Default build command.

staticAssetsDirectory

Type: string

Directory where the framework stores static assets where relevant for the framework.

env

Type: object

Environment variables that should be set when running the dev command.

plugins

Type: object[]

A list of Netlify build plugins package names and conditions. If a condition is met for a plugin it will be returned in the framework's plugin's list.

For example

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

@netlify/framework-info dependencies

ajv semver find-up process p-filter p-locate filter-obj locate-path read-pkg-up is-plain-obj

@netlify/framework-info development dependencies

cpy vite vitest cpy-cli fast-glob typescript tmp-promise babel-loader npm-run-all2 path-browserify rollup-plugin-node-polyfills

FAQs

What is @netlify/framework-info?

Framework detection utility. Visit Snyk Advisor to see a full health score report for @netlify/framework-info, including popularity, security, maintenance & community analysis.

Is @netlify/framework-info popular?

The npm package @netlify/framework-info receives a total of 107,424 weekly downloads. As such, @netlify/framework-info popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @netlify/framework-info well maintained?

We found that @netlify/framework-info demonstrated a healthy version release cadence and project activity. It has a community of 100 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @netlify/framework-info safe to use?

The npm package @netlify/framework-info was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 5 November-2024, at 00:08 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (107,424)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Example (Node.js)

Installation

Usage (Node.js)

listFrameworks(options?)

Options

projectDir

Return value

id

name

category

dev

commands

port

pollingStrategies

build

commands

directory

staticAssetsDirectory

env

plugins

hasFramework(frameworkId, options?)

getFramework(frameworkId, options?)

Usage (CLI)

Add or update a framework

id

name

category

detect

npmDependencies

excludedNpmDependencies

configFiles

dev

command

port

pollingStrategies

build

command

directory

staticAssetsDirectory

env

plugins

@netlify/framework-info dependencies

@netlify/framework-info development dependencies

FAQs

What is @netlify/framework-info?

Is @netlify/framework-info popular?

Is @netlify/framework-info well maintained?

Is @netlify/framework-info safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues