Skip to content
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

Config files (data.json module.json) #14

Closed
2 tasks done
SteelAlloy opened this issue Nov 16, 2020 · 0 comments
Closed
2 tasks done

Config files (data.json module.json) #14

SteelAlloy opened this issue Nov 16, 2020 · 0 comments
Milestone

Comments

@SteelAlloy
Copy link
Member

SteelAlloy commented Nov 16, 2020

  • parse files
  • type checking
// .nest/module.json

{
  "$schema": "https://nest.land/-/nest-cli/schema.json",

  "name": "mod",
  "full_name": "My Awesome Module",
  "description": "I swear my module is the best out there",
  "homepage": "https://my.awesome.module",
  "license": "LICENSE",

  "hooks": {
    "presync": "command",
    "postsync": "command",
    "prepack": "command",
    "postpack": "command",
    "prepublish": "command",
    "postpublish": "command",
    "preaudit": "command",
    "postaudit": "command"
  },

  "unlisted": false,
  "private": false
  // ...
}
// .nest/module.json interface
interface Module {
  $schema: string;

  name: string;
  fullName?: string; // default: `${name}`
  description?: string; // default: ""
  homepage?: string; // default: `https://nest.land/x/${user}/${module}`
  license?: string; // default: "UNKNOWN"

  hooks: {
    presync: string; // default: ""
    postsync: string; // default: ""
    prepack: string; // default: ""
    postpack: string; // default: ""
    prepublish: string; // default: ""
    postpublish: string; // default: ""
    preaudit: string; // default: ""
    postaudit: string; // default: ""
  };

  unlisted?: boolean; // default: false
  private?: boolean; // default: false
  // ...
}
// .nest/data.json

// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.

{
  "meta": {
    "name": "mod",
    "full_name": "My Awesome Module",
    "description": "I swear my module is the best out there",
    "homepage": "https://my.awesome.module",
    "license": "LICENSE",

    "hooks": {
      "presync": "command",
      "postsync": "command",
      "prepack": "command",
      "postpack": "command",
      "prepublish": "command",
      "postpublish": "command",
      "preaudit": "command",
      "postaudit": "command"
    },

    "unlisted": false,
    "private": false
    // ...
  },
  // cache the api for offline use
  "api": {
    "versions": ["1.0.0", "0.9.8", "0.9.7", "..."],
    "latestVersion": "1.0.0",
    "lastPublished": 1603171976111,
    "license": "MIT"
    // ...
  },
  "version": "1.0.0", // nest cli version
  "lastSync": 1602831956336,
  "nextAutoSync": 1602832005131
  // ...
}
@SteelAlloy SteelAlloy added this to the MVP 1 milestone Nov 16, 2020
@SteelAlloy SteelAlloy changed the title Config files (data.json module.json) Config files (data.json module.json ignore) Dec 15, 2020
@SteelAlloy SteelAlloy changed the title Config files (data.json module.json ignore) Config files (data.json module.json) Dec 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant