Skip to content

johron/pues

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pues

  • Initialize and manage projects easily with json blueprints

Install

luarocks install pues
pues --version

Todo

  • I de auto genererte readme-ene i pues blir kommandene skrevet som 'print' istedenfor print()
  • Legg til melding i readme at dette er generert med pues og at for å bruke denne konfigurasjonen må en bruke pues

Blueprint documentation

  • version: The version this blueprint was made for
  • source?: Name of zip archive located in '~/.config/pues/archives/' without extention
  • readme?: If a readme should be included
    • default = false
  • managed?: If the project should be managed by pues
    • default = true
  • build?: Table of shell commands (This can have "%{arg}" in it to tunnel arguments into the pues command)
  • run?: Table of shell commands (This can have "%{arg}" in it to tunnel arguments into the pues command)
  • marked?: Files where '%{name}' should be replaced with project name
  • dependencies?: Project dependencies
    • Table with name as the package manager name
      • command: The command to install with the package manager
      • packages: Table with the packages to be installed

Example Blueprint

{
    "version": "0.0.1",
    "source": "example",
    "readme": true,
    "managed": true,
    "build": [
        "tsc src/main.ts"
    ],
    "run": [
        "ts-node src/main.ts %{arg}"
    ],
    "marked": [
        "package.json"
    ],
    "dependencies": {
        "npm": {
            "command": "npm install",
            "packages": [
                "[email protected]",
                "package"
            ]
        },
        "luarocks": {
            "command": "luarocks install",
            "packages": [
                "module 1.2-3"
            ]
        }
    }
}

Dependencies

  • zzip.h, can be installed with 'apt install zziplib-dev', 'dnf install zziplib-devel'
  • for rest see latest rockspec in rockspecs, these are installed automatically when using luarocks

Building with luarocks

luarocks make rockspecs/pues-<version>.rockspec

Testing

  • Using the docker and the provided Dockerfile is recommended when testing

With luarocks (recommended)

luarocks make rockspecs/pues-<version>.rockspec
pues --version

Without luarocks

lua pues/main.lua --version

License

  • This source code is subject to the terms of the GNU General Public License, version 3. License