Replace/deprecate the outdated spec repo with an in-repo schema

[cybtachyon]

As per the previous discussion in #1000

Did we already link in the doc/spec updates PR for this or do I need to go make one to https://github.com/pattern-lab/the-spec/ to update the spec & docs?

@cybtachyon Spec? What spec? (Seriously, all I see is rough outline that hasn’t gotten updated in a long time).

IMHO, what we REALLY need is a schema that lives in the same repo as the rest of PL’s code (not a separate repo that’s guaranteed to go out of date). That’s the sort of thing that can get tested against, have documentation generated from it, and can get enforced.

[sghoweri]

Thanks @cybtachyon!

[cybtachyon]

@sghoweri Do we have any examples of another working repo for what this would look like?

[stale]

It's hard to keep track of everything. This issue has been automatically marked as stale because it has not had recent activity, neither from the team nor the community. It will be closed if no further activity occurs. Please consider adding additional info, volunteering to contribute a fix for this issue, or making a further case that this is important to you, the team, and the project as a whole. Thanks!

[cybtachyon]

@sghoweri wrote:

Here's a bunch of examples to hopefully get you going on this:

Full config example:
https://github.com/bolt-design-system/bolt/blob/master/docs-site/.boltrc.js

Simpler config example:
https://github.com/bolt-design-system/bolt/blob/master/example-integrations/drupal-lab/web/themes/bolt-starter/.boltrc.js

Build Tools Schema that .boltrc configs get validated against:
https://github.com/bolt-design-system/bolt/blob/master/packages/build/tools/utils/config.schema.yml

If we were to use the Bolt Design System's schema architecture as an example: there's two basic schema types / two different areas that we deal with schema validation:

We have the build tools schema (which the above config files + schema are a part of) which ensure that the shorthand Webpack config we use stays up to date + barks at you in our CLI when you try to run the build tools and have missing config options that are required, try to add new config options that don't exist, etc (pretty standard schema stuff)

Separately we have our component-specific schemas (ex. https://boltdesignsystem.com/pattern-lab/?p=viewall-components-blockquote)

Which we validate in Twig and in our Web Components:

• https://github.com/bolt-design-system/bolt/blob/master/packages/components/bolt-blockquote/blockquote.schema.yml
• https://github.com/bolt-design-system/bolt/blob/master/packages/components/bolt-blockquote/src/blockquote.js
• https://github.com/bolt-design-system/bolt/blob/master/packages/components/bolt-blockquote/src/blockquote.twig#L4

Basically I'm thinking that the PL spec could consist of a few different types of schemas -- one for configuring the build / tooling itself, another for handling component-specific data that gets assembled, and probably at least a 3rd for plugins that add / modify / extend functionality and data in PL

The first two especially (for starters) ^

Once we have some rough schemas, we have tools (the PL CLI or Node.js API, helper JS utils for template renderers, etc) that check to make sure the data expected in the PL config itself (or in the Pattern Data when something is getting rendered) matches what's expected

[stale]

It's hard to keep track of everything. This issue has been automatically marked as stale because it has not had recent activity, neither from the team nor the community. It will be closed if no further activity occurs. Please consider adding additional info, volunteering to contribute a fix for this issue, or making a further case that this is important to you, the team, and the project as a whole. Thanks!

[cybtachyon]

Please upvote the original comment with a 👍 if this issue is important to you.

This issue is in our internal backlog.

[stale]

It's hard to keep track of everything. This issue has been automatically marked as stale because it has not had recent activity, neither from the team nor the community. It will be closed if no further activity occurs. Please consider adding additional info, volunteering to contribute a fix for this issue, or making a further case that this is important to you, the team, and the project as a whole. Thanks!

[stale]

Issue closed after going stale. It can be re-opened if still relevant.