@netlify/framework-info
Advanced tools
Package description
@netlify/framework-info is an npm package designed to provide information about various web frameworks. It helps in detecting the framework used in a project and provides relevant details, which can be useful for deployment and configuration purposes.
Detect Framework
This feature allows you to detect the framework used in a given project directory. The `getFramework` function returns details about the detected framework, such as its name and version.
const { getFramework } = require('@netlify/framework-info');
async function detectFramework() {
const framework = await getFramework({
projectDir: process.cwd(),
});
console.log(framework);
}
detectFramework();List All Frameworks
This feature provides a list of all frameworks that the package can detect. The `listFrameworks` function returns an array of framework objects, each containing details like name, category, and detection criteria.
const { listFrameworks } = require('@netlify/framework-info');
async function listAllFrameworks() {
const frameworks = await listFrameworks();
console.log(frameworks);
}
listAllFrameworks();The `detect-framework` package is used to detect the framework used in a project. It provides similar functionality to @netlify/framework-info but may not have as extensive a list of supported frameworks.
The `framework-detector` package helps in identifying the framework used in a project directory. It offers similar detection capabilities but may differ in the way it categorizes and reports framework information.
Readme
Framework detection utility.
Detects which framework a specific website is using. The framework's build/watch commands, directories and server port are also returned.
The following frameworks are detected:
Additions and updates are welcome!
const { listFrameworks, getFramework } = require('@netlify/framework-info')
console.log(await listFrameworks({ projectDir: './path/to/gatsby/website' }))
// [
// {
// name: 'gatsby',
// category: 'static_site_generator',
// watch: {
// commands: ['gatsby develop'],
// directory: 'public',
// port: 8000
// },
// env: { GATSBY_LOGGER: 'yurnalist' }
// }
// ]
console.log(await listFrameworks({ projectDir: './path/to/vue/website' }))
// [
// {
// name: 'vue',
// category: 'frontend_framework',
// watch: {
// commands: ['npm run serve'],
// directory: 'dist',
// port: 8080
// },
// env: {}
// }
// ]
console.log(await getFramework('vue', { projectDir: './path/to/vue/website' }))
// {
// name: 'vue',
// category: 'frontend_framework',
// watch: {
// commands: ['npm run serve'],
// directory: 'dist',
// port: 8080
// },
// env: {}
// }
$ framework-info ./path/to/gatsby/website
gatsby
$ framework-info --long ./path/to/vue/website
[
{
"name": "vue",
"category": "frontend_framework",
"watch": {
"commands": ["npm run serve"],
"directory": "dist",
"port": 8080
},
"env": {}
}
]
npm install @netlify/framework-info
options: object?
Return value: Promise<object[]>
Type: string
Default value: process.cwd()
Path to the website's directory.
Type: string
When detecting the watch command, ignore package.json scripts whose value includes this string.
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.
Type: string
Name such as "gatsby".
Type: string
Category among "static_site_generator", "frontend_framework" and "build_tool".
Type: object
Information about the build command, in watch mode.
Type: string[]
Build command, in watch mode. There might be several alternatives.
Type: string
Relative path to the directory where files are built, in watch mode.
Type: number
Server port.
Type: object
Environment variables that should be set when calling the watch command.
options: object?
Return value: Promise<object>
Same as listFramework() except the framework is passed as argument instead of being
detected. A single framework object is returned.
$ framework-info [projectDirectory]
This prints the names 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.--ignoredWatchCommand stringEach framework is a JSON file in the /src/frameworks/ directory. For example:
{
"name": "gatsby",
"category": "static_site_generator",
"detect": {
"npmDependencies": ["gatsby"],
"excludedNpmDependencies": [],
"configFiles": ["gatsby-config.js"]
},
"watch": {
"command": "gatsby develop",
"directory": "public",
"port": 8000
},
"env": { "GATSBY_LOGGER": "yurnalist" }
}
All properties are required.
Type: string
Name of the framework, lowercase.
Type: string
One of "static_site_generator", "frontend_framework" or "build_tool".
Type: object
Information used to detect this framework
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.
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.
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.
Type: object
Parameters to detect the watch command.
Type: string
Default watch command.
Type: string
Directory where built files are written to, in watch mode.
Type: number
Local watch server port.
Type: object
Environment variables that should be set when running the watch command.
FAQs
Unknown package
We found that @netlify/framework-info demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 23 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A threat actor on BreachForums is selling an unverified npm vulnerability for account takeover, but npm has not officially confirmed the existence of this security concern.
Security News
Cyber insurance rates are dropping as the market matures, according to a new report projecting global premiums to reach $43 billion by 2030, driven by international market uptake and growth in the SME sector.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.