Giter VIP home page Giter VIP logo

Comments (10)

philips avatar philips commented on August 18, 2024

+1 on that. It would be nice to have it test both the markdown embedded and examples but that is more of a nice to have.

from image-spec.

vbatts avatar vbatts commented on August 18, 2024

So we could add the files from the embedded markdown examples as files, and have a test target against them.
https://gist.github.com/vbatts/b3e4fc231fbc92a9cbc28b9184f0b2d2 is what I was using when writing the schema.

I'm not really sure of a clean way to work with the examples while they're embedded in the markdown though.

from image-spec.

wking avatar wking commented on August 18, 2024

On Sat, Apr 16, 2016 at 07:57:13AM -0700, Vincent Batts wrote:

I'm not really sure of a clean way to work with the examples while
they're embedded in the markdown though.

Probably just make sure all embedded examples are subsets of the
stand-alone example JSON. It shouldn't be too hard to pull out the
JSON blocks by looking for ‘json’ and ‘’ delimiters, and then
checking to see if that snippet is contained in one of a set of
stand-alone files. If this approach sounds useful, I'm happy to write
tooling for it (although it would probably be in Python ;).

from image-spec.

philips avatar philips commented on August 18, 2024

@stevvooe Are you going to work on this?

from image-spec.

stevvooe avatar stevvooe commented on August 18, 2024

I can look into it, but I'm not very familiar with JSONSchema. If anyone could suggest tools or an approach, that would be helpful.

I'll probably just use a Go package and a Makefile, barring common tools above.

from image-spec.

wking avatar wking commented on August 18, 2024

On Wed, Apr 20, 2016 at 03:56:44PM -0700, Stephen Day wrote:

I can look into it, but I'm not very familiar with JSONSchema. If
anyone could suggest tools or an approach, that would be helpful.

#18 and #32 already landed the JSON Schema and Go tooling for
validating stand-alone JSON 1, so you probably don't need to write
new stuff there. There's a README for that approach in 2, if that
helps get you started.

You will need to add the example JSON manifests, etc. that are used to
test the schema, and some tooling to run validate.go against the
example manifests, etc.

from image-spec.

stevvooe avatar stevvooe commented on August 18, 2024

@wking Thanks!

validate.go should be sufficient to get started. Do we want to consider the specification to be the source of all golden standards?

from image-spec.

stevvooe avatar stevvooe commented on August 18, 2024

Took a small pass at this in #41.

#41 proposes maintaining examples in specifications. All examples are a part of the specification, rather than maintaining them in external files.

If we like that approach, I can round out that PR and we can move forward.

from image-spec.

vbatts avatar vbatts commented on August 18, 2024

I like it.

On Thu, Apr 21, 2016 at 8:42 PM, Stephen Day [email protected]
wrote:

Took a small pass at this in #41
#41.

#41 #41 proposes
maintaining examples in specifications. All examples are a part of the
specification, rather than maintaining them in external files.

If we like that approach, I can round out that PR and we can move forward.


You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#34 (comment)

from image-spec.

vbatts avatar vbatts commented on August 18, 2024

Also, it would dictate that a new item for the style.md showing how to do
the mime-type json examples.

On Fri, Apr 22, 2016 at 10:39 AM, Vincent Batts [email protected]
wrote:

I like it.

On Thu, Apr 21, 2016 at 8:42 PM, Stephen Day [email protected]
wrote:

Took a small pass at this in #41
#41.

#41 #41 proposes
maintaining examples in specifications. All examples are a part of the
specification, rather than maintaining them in external files.

If we like that approach, I can round out that PR and we can move forward.


You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#34 (comment)

from image-spec.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.