Skip to content

Document new performance budgets feature #435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
TheLarkInn opened this issue Nov 25, 2016 · 7 comments
Closed

Document new performance budgets feature #435

TheLarkInn opened this issue Nov 25, 2016 · 7 comments

Comments

@TheLarkInn
Copy link
Member

Now that most of the details are stamped out for webpack/webpack#3350 (review), we need to ensure that we are documenting the new configuration features, as well as specify what they represent.

Here is the schema for the new information:

    "performance": {
      "description": "Configuration for web performance recommendations.",
      "additionalProperties": false,
      "properties": {
        "hints": {
          "description": "Turn hints on or off",
          "type": "boolean"
        },
        "maxInitialChunkSize": {
          "description": "Total size of all initial chunks (in bytes)",
          "type": "number"
        },
        "maxAssetSize": {
          "description": "Filesize limit (in bytes) when exceeded, that webpack will provide performance hints",
          "type": "number"
        },
        "errorOnHint": {
          "description": "Throw errors instead of warnings when performance hints are found",
          "type": "boolean"
        }
      },
      "type": "object"
    }

Performance property:
Default recommendations about web practice and performance.

Reference webpack/webpack#3216 for more details.

@TheLarkInn
Copy link
Member Author

    "performance": {
      "description": "Configuration for web performance recommendations.",
      "anyOf": [
        {
          "enum": [
            false
          ]
        },
        {
          "additionalProperties": false,
          "properties": {
            "assetFilter": {
              "description": "Filter function to select assets that are checked",
              "instanceof": "Function"
            },
            "hints": {
              "description": "Sets the format of the hints: warnings, errors or nothing at all",
              "enum": [
                false,
                "warning",
                "error"
              ]
            },
            "maxEntrypointSize": {
              "description": "Total size of an entry point (in bytes)",
              "type": "number"
            },
            "maxAssetSize": {
              "description": "Filesize limit (in bytes) when exceeded, that webpack will provide performance hints",
              "type": "number"
            }
          },
          "type": "object"
        }
      ]
    },

this is the new schema, holding for my reference

@tarang9211
Copy link
Contributor

@TheLarkInn can i help on this issue?

@TheLarkInn
Copy link
Member Author

Looks like we missed this just a few days before closing this!!! Sorry I submitted and merged the PR for this feature. There are some other issues I'd be happy to assist you with. Feel free and @ mention me again next time (I should actually get it now), and I'll assist where needed.

@tarang9211
Copy link
Contributor

No problem @TheLarkInn
Could you point me to some beginner friendly issues for this repo? I'm completely new to the webpack repo and looking to help!

@TheLarkInn
Copy link
Member Author

Sure well just looking at the issue list on here and finding something you are already comfortable with is a great start. Otherwise you can goto the webpack/webpack repo also and look at issues with a D* label which will tell you what the degree of difficulty will be.

@tarang9211
Copy link
Contributor

D0 being the easiest contributions, right?

@TheLarkInn
Copy link
Member Author

Yes :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants