chore: add JSON schema for `netlify.toml` #4585

danez · 2022-10-07T14:17:28Z

Summary

This PR adds a new JSON schema file for netlify.toml. A direct link to this file will be added to https://github.com/SchemaStore/schemastore. Most IDEs (vscode with extension, intellij) try to read schemas from this store.

In the future, the schema could even be used to validate the netlify.toml file in @netlify/config, as I saw right now we have some hardcoded validation in the code.

The new package is private for now, so even if we want to rename it later into maybe config-validation we can simply do this.

I added docs as reviewer, because I added a lot of links pointing to the docs and also copied most of the text from the docs.

Ref: https://github.com/netlify/pod-compute/issues/138

A picture of a cute animal (not mandatory, but encouraged)

lukasholzer · 2023-02-02T10:19:50Z

@danez any updates on this one? Would love having autocompletion for the toml 😂

packages/config-schema/src/schema/netlify-toml.schema.json

codebyuma

Hey @danez, sorry for the delay in reviewing this.

I know you copied all of these from the docs but I left a number of suggested edits to make some items more concise, clearer, or to just follow a more consistent format. Hopefully they should be quick and easy to apply but let me know if you have questions.

Since there are a bunch of edits, I'll go ahead and request changes here. But I'll keep an eye out to re-review this once you're ready.

packages/config-schema/src/schema/netlify-toml.schema.json

github-actions · 2023-03-30T12:57:05Z

~~This pull request adds or modifies JavaScript (.js, .cjs, .mjs) files. Consider converting them to TypeScript.~~
Thank you for converting JavaScript files to TypeScript 🎉"

codebyuma

Hey @danez thanks for making these changes!

In this review, I spotted one typo that I missed last time and I tagged @klavavej to review the caching updates as I know the docs for EF caching are still a WIP. I just want to make sure we use the same language. I did leave some suggestions in the meantime.

I also checked all your links this time and can confirm they work as expected 👍

I don't see any blockers, so I'll approve. But it might be worth waiting for Kristen's approval too.

codebyuma · 2023-03-30T14:28:55Z

packages/config-schema/src/schema/netlify-toml.schema.json

+  "definitions": {
+    "BasePath": {
+      "title": "Base path",
+      "description": "Directory to change to before starting a build. This is where we will look dependency management files such as `package.json` or `.nvmrc`. If not set, defaults to the root directory.",


Ah, I must have made a typo in my suggestion, sorry. We're missing a word here

Suggested change

"description": "Directory to change to before starting a build. This is where we will look dependency management files such as `package.json` or `.nvmrc`. If not set, defaults to the root directory.",

"description": "Directory to change to before starting a build. This is where we will look for dependency management files such as `package.json` or `.nvmrc`. If not set, defaults to the root directory.",

packages/config-schema/src/schema/netlify-toml.schema.json

klavavej

Thanks for the ping @codebyuma ! I left a few notes but nothing blocking from me either so I will approve

packages/config-schema/src/schema/netlify-toml.schema.json

lukasholzer

I think the template field is missing on the root and the functions field on the build settings.

[build]
  # This is where we will look for your lambda functions
  functions = "project/functions/"

and for example:

# Set enviroment variable prompts for templates
[template.environment]
  YOUR_ENV_KEYS_NEEDED = "Enter in the ENV key here"
  # ref https://bit.ly/2wQ1mVk
  incoming-hooks = ["Service-1"]

danez · 2023-04-14T13:04:40Z

and the functions field on the build settings

The docs though say it should be this:

[functions]
  directory = "my_functions"

maybe [build] -> functions is the old way of doing it?

lukasholzer · 2023-04-14T13:06:53Z

and the functions field on the build settings

The docs though say it should be this:
[functions]
  directory = "my_functions"
maybe [build] -> functions is the old way of doing it?

mhm maybe @eduardoboucas can put some light on that?

codebyuma

From a docs content POV, I think this is good to go. I just reviewed your latest commits and also reviewed against the suggestions Kristen left last 👍

I left three small suggested edits for the new content that was just added (templates, etc) but none of them are blocking, so you can decide whether to apply them or leave them as-is to finally get this merged 🙂

packages/config-schema/src/schema/netlify-toml.schema.json

lukasholzer · 2023-04-17T09:23:38Z

packages/config-schema/src/schema/netlify-toml.schema.json

+          "title": "Publish path",
+          "description": "Setting to use if a project is detected incorrectly, flagged by multiple detectors, or requires a `command` and `targetPort`.",
+          "type": "string",
+          "enum": ["#auto", "#static", "#custom"],


should have a regular string here as well like next

Interesting, it seems the docs need an update then too maybe.

I removed the enum and made it a simple string for now. LAter one we could make it an enum again, but generate it with all the framework names :)

lukasholzer · 2023-04-17T09:24:54Z

packages/config-schema/src/schema/netlify-toml.schema.json

+      "description": "Netlify Dev enables a local development environment without any additional setup and this includes using the functions directory setting to scaffold and serve your functions locally. You can use the `[dev]` section to configure this local development environment. \n\nNote that `[dev]` doesn't run in the Bash shell, so you won't be able to use Bash-compatible syntax with the command.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {


I think some fields are still missing regarding the dev config from the CLI:
https://github.com/netlify/cli/blob/main/src/commands/dev/types.d.ts#L3-L22

like: staticServerPort or envFiles or functions and live

live is only a cli option and is never read from the devConfig afaics. I added envFiles and staticServerPort as they make sense (we should add them to the docs too). functions though I do not think is useful, where would having a different functions directory locally help? I have a hunch that functions is only part of the devConfig because we needed a way to transmit the setting to different methods, here it was introduced So I did not add it.

codebyuma

Left one small suggested edit but otherwise the latest updates look good to me 🤞

packages/config-schema/src/schema/netlify-toml.schema.json

codebyuma

Not sure if you still need another technical review but the copy looks good to me 🚢

Co-authored-by: Uma Chandran <codebyuma@users.noreply.github.com>

danez · 2023-07-14T13:04:22Z

The config for edge functions is currently incorrect in the schema:

excludePattern, excludePath and pattern are missing from the schema
path is currently only allowed to be a string, but it can also be an array of strings

danez requested a review from lukasholzer October 7, 2022 14:17

danez force-pushed the json-schema branch from 3d8d917 to eca162f Compare October 7, 2022 14:21

github-actions bot added the stale label Dec 17, 2022

github-actions bot removed the stale label Feb 2, 2023

danez force-pushed the json-schema branch from eca162f to eceaf7e Compare March 3, 2023 14:16

danez changed the title ~~chore: add JSON schema for netlify-toml WIP~~ chore: add JSON schema for netlify.toml Mar 3, 2023

danez self-assigned this Mar 3, 2023

danez force-pushed the json-schema branch 2 times, most recently from 18e199e to 6847f55 Compare March 3, 2023 15:50

danez requested a review from a team March 3, 2023 15:52

danez added the echoes/initiative: first-friday label Mar 3, 2023

danez marked this pull request as ready for review March 3, 2023 15:52

danez commented Mar 3, 2023

View reviewed changes

packages/config-schema/src/schema/netlify-toml.schema.json Show resolved Hide resolved

danez requested a review from a team March 3, 2023 15:59

danez force-pushed the json-schema branch 2 times, most recently from 98eb976 to 4a88be6 Compare March 3, 2023 16:12

rstavchansky requested a review from codebyuma March 3, 2023 18:48

codebyuma requested changes Mar 9, 2023

View reviewed changes

github-actions bot added Adds or modifies js files and removed Adds or modifies js files labels Mar 30, 2023

danez requested a review from codebyuma March 30, 2023 14:23

codebyuma previously approved these changes Mar 30, 2023

View reviewed changes

klavavej previously approved these changes Mar 30, 2023

View reviewed changes

lukasholzer reviewed Mar 31, 2023

View reviewed changes

danez dismissed stale reviews from klavavej and codebyuma via a973943 April 14, 2023 14:29

danez requested review from klavavej and lukasholzer April 14, 2023 15:04

codebyuma previously approved these changes Apr 14, 2023

View reviewed changes

packages/config-schema/src/schema/netlify-toml.schema.json Outdated Show resolved Hide resolved

packages/config-schema/src/schema/netlify-toml.schema.json Outdated Show resolved Hide resolved

packages/config-schema/src/schema/netlify-toml.schema.json Outdated Show resolved Hide resolved

lukasholzer reviewed Apr 17, 2023

View reviewed changes

danez added the Ecosystem: Dev Foundations label May 8, 2023

codebyuma removed the request for review from klavavej June 1, 2023 19:55

danez dismissed codebyuma’s stale review via d746a1c June 9, 2023 09:36

github-actions bot added the Adds or modifies js files label Jun 9, 2023

danez requested a review from a team as a code owner June 9, 2023 10:22

danez requested review from lukasholzer, codebyuma and klavavej June 9, 2023 10:23

danez force-pushed the json-schema branch from 793e98b to bc2137c Compare June 9, 2023 10:31

github-actions bot removed the Adds or modifies js files label Jun 9, 2023

codebyuma previously approved these changes Jun 12, 2023

View reviewed changes

packages/config-schema/src/schema/netlify-toml.schema.json Outdated Show resolved Hide resolved

danez dismissed codebyuma’s stale review via 2d84d8e June 13, 2023 10:24

codebyuma previously approved these changes Jun 13, 2023

View reviewed changes

codebyuma removed the request for review from klavavej June 15, 2023 15:04

danez dismissed codebyuma’s stale review via a4285aa July 3, 2023 12:35

danez force-pushed the json-schema branch 3 times, most recently from 22d3967 to 29e80c2 Compare July 3, 2023 12:39

d3v1an7 mentioned this pull request Jul 5, 2023

edge_functions failing validation when using documented properties #5120

Closed

chore: add JSON schema for netlify-toml

cbfd9d1

Co-authored-by: Uma Chandran <codebyuma@users.noreply.github.com>

danez force-pushed the json-schema branch from 29e80c2 to cbfd9d1 Compare July 6, 2023 10:44

danez requested a review from a team as a code owner July 6, 2023 10:44

danez removed their assignment Aug 15, 2023

github-actions bot added the stale label Oct 14, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: add JSON schema for `netlify.toml` #4585

chore: add JSON schema for `netlify.toml` #4585

danez commented Oct 7, 2022 •

edited

lukasholzer commented Feb 2, 2023

codebyuma left a comment

github-actions bot commented Mar 30, 2023 •

edited

codebyuma left a comment

codebyuma Mar 30, 2023

klavavej left a comment

lukasholzer left a comment •

edited

danez commented Apr 14, 2023 •

edited

lukasholzer commented Apr 14, 2023

codebyuma left a comment

lukasholzer Apr 17, 2023

danez Jun 9, 2023

danez Jun 9, 2023

lukasholzer Apr 17, 2023

danez Jun 9, 2023 •

edited

codebyuma left a comment

codebyuma left a comment

danez commented Jul 14, 2023

	"description": "Directory to change to before starting a build. This is where we will look dependency management files such as `package.json` or `.nvmrc`. If not set, defaults to the root directory.",
	"description": "Directory to change to before starting a build. This is where we will look for dependency management files such as `package.json` or `.nvmrc`. If not set, defaults to the root directory.",

chore: add JSON schema for netlify.toml #4585

Are you sure you want to change the base?

chore: add JSON schema for netlify.toml #4585

Conversation

danez commented Oct 7, 2022 • edited

Summary

lukasholzer commented Feb 2, 2023

codebyuma left a comment

Choose a reason for hiding this comment

github-actions bot commented Mar 30, 2023 • edited

codebyuma left a comment

Choose a reason for hiding this comment

codebyuma Mar 30, 2023

Choose a reason for hiding this comment

klavavej left a comment

Choose a reason for hiding this comment

lukasholzer left a comment • edited

Choose a reason for hiding this comment

danez commented Apr 14, 2023 • edited

lukasholzer commented Apr 14, 2023

codebyuma left a comment

Choose a reason for hiding this comment

lukasholzer Apr 17, 2023

Choose a reason for hiding this comment

danez Jun 9, 2023

Choose a reason for hiding this comment

danez Jun 9, 2023

Choose a reason for hiding this comment

lukasholzer Apr 17, 2023

Choose a reason for hiding this comment

danez Jun 9, 2023 • edited

Choose a reason for hiding this comment

codebyuma left a comment

Choose a reason for hiding this comment

codebyuma left a comment

Choose a reason for hiding this comment

danez commented Jul 14, 2023

chore: add JSON schema for `netlify.toml` #4585

chore: add JSON schema for `netlify.toml` #4585

danez commented Oct 7, 2022 •

edited

github-actions bot commented Mar 30, 2023 •

edited

lukasholzer left a comment •

edited

danez commented Apr 14, 2023 •

edited

danez Jun 9, 2023 •

edited