Shit

Appearance

Create Packages ​

Basic Create ​

In shit cli, you can run shit --create <Package Name> to create a default package with zip format. This package just includes a package.json and an empty .pkgtype.

For example: Run shit --create test.pkg We will get a package test.pkg Compress it, you will get:

sh
$ tree test/
├── package.json
└── .pkgtype

File Description ​

  • .pkgtype: the package's type, DO NOT EDIT!
  • package.json: the package configure you need to edit, it includes:
    • authors: the package's authors
    • description: the package's description
    • license: the package's license (like MIT, Apache-2.0, etc)
    • name: the package's name
    • version: the package's version

Create specialize package ​

At the most of time, we need to get a type of package. You can run shit --create <Package Name> --type <Package Type>

For example:

sh
shit --create test.pkg --type style

You will get a style package named test.pkg Compress it, you will get:

sh
$ tree test/
├── style
│   └── main.lua
├── package.json
└── .pkgtype

File Description ​

  • style/main.lua: the lua configure, you need to write lua codes into it