Git Product home page Git Product logo

project.json's Introduction

My proposal for the "Front-end tools and existing projects" issue / problem.

By Tom Lane


Project.json

A common hook for front end tools to access project structure and information.

What is it?

A simple JSON file that states essential information for front-end tools to be able to just drop in to an existing project and begin working straight away.

Why is it needed?

Most front-end tools (such as Yeoman) are only compatible if the project is created using the tool itself and has no support for existing projects.

How will it be implemented?

Implementation will need to happen in 2 stages:

  • Tools need to check for the existence of this file and work accordingly.
  • Existing projects need to create a project.json file in order for it to be used and processed by the tools.

What would a typical project.json file include?

  • Directory information.
    • CSS
      • Pre-processor input directory.
      • CSS output directory.
      • Linting?
      • Minifying?
    • Javascript
      • Pre-processor input directory (e.g. coffeescript).
      • JS output directory.
      • Linting?
      • Minifying?
    • HTML
      • Pre-processor input directory.
      • HTML output directory.
      • Linting?
      • Minifying?
    • Project server directory
      • Where to serve files from for local server testing.
  • Existing tools used.

Would it be extensible?

Yes, being JSON the contents and uses can be very flexible. For example, existing JSON such as Bower's component.json can easily be integrated.

project.json's People

Watchers

James Cloos avatar

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.