@netlify/framework-info - npm Package Compare versions

Comparing version 3.0.0 to 3.1.0

CHANGELOG.md

@@ -10,2 +10,9 @@ # Changelog
 
+## [3.1.0](https://www.github.com/netlify/framework-info/compare/v3.0.0...v3.1.0) (2021-02-11)
+
+
+### Features
+
+* **dev:** add polling strategies ([#125](https://www.github.com/netlify/framework-info/issues/125)) ([4c553e8](https://www.github.com/netlify/framework-info/commit/4c553e8be40f6b01948ccbeb56ee58f86dd6bfb0))
+
 ## [3.0.0](https://www.github.com/netlify/framework-info/compare/v2.3.0...v3.0.0) (2021-02-10)
@@ -12,0 +19,0 @@

package.json

 {
   "name": "@netlify/framework-info",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Framework detection utility",
@@ -5,0 +5,0 @@ "main": "./src/main.js",

README.md

@@ -33,3 +33,4 @@ [![npm version](https://img.shields.io/npm/v/@netlify/framework-info.svg)](https://npmjs.org/package/@netlify/framework-info)
 //       commands: ['gatsby develop'],
-//       port: 8000
+//       port: 8000,
+//       pollingStrategies: [{ name: 'TCP' }, { name: 'HTTP' }]
 //     },
@@ -53,3 +54,4 @@ //     build: {
 //       commands: ['npm run serve'],
-//       port: 8080
+//       port: 8080,
+//       pollingStrategies: [{ name: 'TCP' }, { name: 'HTTP' }]
 //     },
@@ -75,3 +77,4 @@ //     build: {
 //     commands: ['npm run serve'],
-//     port: 8080
+//     port: 8080,
+//     pollingStrategies: [{ name: 'TCP' }, { name: 'HTTP' }]
 //   },
@@ -101,3 +104,4 @@ //   build: {
       "commands": ["npm run serve"],
-      "port": 8080
+      "port": 8080,
+      "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
     },
@@ -179,2 +183,8 @@ "build": {
 
+##### pollingStrategies
+
+_Type_: `object[]`
+
+Polling strategies to use when checking if the dev server is ready.
+
 #### build
@@ -255,3 +265,4 @@
     "command": "gatsby develop",
-    "port": 8000
+    "port": 8000,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -338,2 +349,8 @@ "build": {
 
+### pollingStrategies
+
+_Type_: `object[]`
+
+Polling strategies to use when checking if the dev server is ready.
+
 ## build
@@ -340,0 +357,0 @@

src/core.js

@@ -17,2 +17,7 @@ const pFilter = require('p-filter')
 /**
+ * @typedef {object} PollingStrategy
+ * @property {'TCP'|'HTTP'} name - Name of the polling strategy. Possible names - TCP,HTTP
+ */
+
+/**
  * A callback to check if a path exists
@@ -36,2 +41,3 @@ * @callback PathExists
  * @property {number} port - Server port
+ * @property {PollingStrategy[]} pollingStrategies - Dev Server polling strategies
  */
@@ -139,3 +145,3 @@
     category,
-    dev: { command: frameworkDevCommand, port },
+    dev: { command: frameworkDevCommand, port, pollingStrategies },
     build: { command: frameworkBuildCommand, directory },
@@ -153,3 +159,3 @@ env,
     category,
-    dev: { commands: devCommands, port },
+    dev: { commands: devCommands, port, pollingStrategies },
     build: { commands: [frameworkBuildCommand], directory },
@@ -156,0 +162,0 @@ env,

src/frameworks/angular.json

@@ -12,3 +12,4 @@ {
     "command": "ng serve",
-    "port": 4200
+    "port": 4200,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/brunch.json

@@ -12,3 +12,4 @@ {
     "command": "brunch watch --server",
-    "port": 3333
+    "port": 3333,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/create-react-app.json

@@ -12,3 +12,4 @@ {
     "command": "react-scripts start",
-    "port": 3000
+    "port": 3000,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/docpad.json

@@ -12,3 +12,4 @@ {
     "command": "docpad run",
-    "port": 9778
+    "port": 9778,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/docusaurus-v2.json

@@ -12,3 +12,4 @@ {
     "command": "docusaurus start",
-    "port": 3000
+    "port": 3000,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/docusaurus.json

@@ -12,3 +12,4 @@ {
     "command": "docusaurus-start",
-    "port": 3000
+    "port": 3000,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/eleventy.json

@@ -12,3 +12,4 @@ {
     "command": "eleventy --serve",
-    "port": 8080
+    "port": 8080,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/ember.json

@@ -12,3 +12,4 @@ {
     "command": "ember serve",
-    "port": 4200
+    "port": 4200,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/expo.json

@@ -12,3 +12,4 @@ {
     "command": "expo start --web",
-    "port": 19006
+    "port": 19006,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/gatsby.json

@@ -12,3 +12,4 @@ {
     "command": "gatsby develop",
-    "port": 8000
+    "port": 8000,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/gridsome.json

@@ -12,3 +12,4 @@ {
     "command": "gridsome develop",
-    "port": 8080
+    "port": 8080,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/harp.json

@@ -12,3 +12,4 @@ {
     "command": "harp server",
-    "port": 9000
+    "port": 9000,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/hexo.json

@@ -12,3 +12,4 @@ {
     "command": "hexo server",
-    "port": 4000
+    "port": 4000,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/hugo.json

@@ -12,3 +12,4 @@ {
     "command": "hugo server -w",
-    "port": 1313
+    "port": 1313,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/jekyll.json

@@ -12,3 +12,4 @@ {
     "command": "bundle exec jekyll serve -w",
-    "port": 4000
+    "port": 4000,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/middleman.json

@@ -12,3 +12,4 @@ {
     "command": "bundle exec middleman server",
-    "port": 4567
+    "port": 4567,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/next.json

@@ -12,3 +12,4 @@ {
     "command": "next",
-    "port": 3000
+    "port": 3000,
+    "pollingStrategies": [{ "name": "TCP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/nuxt.json

@@ -12,3 +12,4 @@ {
     "command": "nuxt",
-    "port": 3000
+    "port": 3000,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/parcel.json

@@ -12,3 +12,4 @@ {
     "command": "parcel",
-    "port": 1234
+    "port": 1234,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/phenomic.json

@@ -12,3 +12,4 @@ {
     "command": "phenomic start",
-    "port": 3333
+    "port": 3333,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/quasar-v0.17.json

@@ -12,3 +12,4 @@ {
     "command": "quasar dev -p 8080",
-    "port": 8080
+    "port": 8080,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/quasar.json

@@ -12,3 +12,4 @@ {
     "command": "quasar dev -p 8081",
-    "port": 8081
+    "port": 8081,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/react-static.json

@@ -12,3 +12,4 @@ {
     "command": "react-static start",
-    "port": 3000
+    "port": 3000,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/roots.json

@@ -12,3 +12,4 @@ {
     "command": "roots watch",
-    "port": 1111
+    "port": 1111,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/sapper.json

@@ -12,3 +12,4 @@ {
     "command": "sapper dev",
-    "port": 3000
+    "port": 3000,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/stencil.json

@@ -12,3 +12,4 @@ {
     "command": "stencil build --dev --watch --serve",
-    "port": 3333
+    "port": 3333,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/svelte.json

@@ -12,3 +12,4 @@ {
     "command": "npm run dev",
-    "port": 5000
+    "port": 5000,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/vue.json

@@ -12,3 +12,4 @@ {
     "command": "vue-cli-service serve",
-    "port": 8080
+    "port": 8080,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/vuepress.json

@@ -12,3 +12,4 @@ {
     "command": "vuepress dev",
-    "port": 8080
+    "port": 8080,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

src/frameworks/wintersmith.json

@@ -12,3 +12,4 @@ {
     "command": "wintersmith preview",
-    "port": 8080
+    "port": 8080,
+    "pollingStrategies": [{ "name": "TCP" }, { "name": "HTTP" }]
   },
@@ -15,0 +16,0 @@ "build": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

224178

increased by2.14%

Lines of code

1823

increased by2.3%

Number of lines in readme file

392

increased by4.53%

No dependency changes