SPEC.md 7.39 KB
Newer Older
Bat's avatar
Bat committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# poulp's specification

*This document aims to provide a description of how poulp will work when it will be prouction-ready.*

## poulp.json

The `poulp.json` file contains some [JSON](http://json.org) defining the properties of a project. It is located at the root of the project.

It can contains the following keys.

### name

The name of the project. It should only contain (small) letters, numbers or hyphens, and it must start with a letter.

```ruby
"my-project" # correct
"my-project-123" # correct

"GTK+ App" # Incorrect : capitals, + and space
Bat's avatar
Bat committed
20
"42-the-meaning-of-life-etc" # Incorrect : begins with a number
Bat's avatar
Bat committed
21
22
```

Bat's avatar
Bat committed
23
*This key is mandatory.*
Bat's avatar
Bat committed
24
25
26
27
28

### version

This is the version of your package. It should be a valid [semantic version](http://semver.org).

Bat's avatar
Bat committed
29
*This key is mandatory.*
Bat's avatar
Bat committed
30
31
32
33
34

### description

This is just a short description of your package.

Bat's avatar
Bat committed
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
### keywords

An array containing strings, which are the keywords of your package. It help people finding them when doing `poulp search`, and on the repositories websites using [poulp server](https://framagit.org/valse/poulp-server).

### homepage

This is a string containing the URL of the projects website.

### bugs

Specifies where to report bugs. It is an object, which can contain this fields.

- `url`, the bug tracker URL ;
- `email`, an email adress where we can send bug reports.

### license

The name of the license of your project.

### author

The name of the author of the project. It could contain an email adress after the name, between `<` `>`.

### contributors

A list of the peoples (string looking like the `author` field) who contributed to this project.

### maintainers

A list of the peoples (string looking like the `author` field) who maintains this project.

### files

The files to include at compilation.

### repository

The URL of the projects repository, where we can find the source code.

Bat's avatar
Bat committed
74
### vapi-dir
Bat's avatar
Bat committed
75
76
77
78
79
80
81

The path to a directory containing personal VAPIs.

### output

Where to put the result of the compilation. Defaults to `build/name-version` (where `name` is the name of the project and `version` the version).

Bat's avatar
Bat committed
82
83
84
85
### library

A boolean that tells us if this project is a library or not. If it is, it will be compiled in a special way, to make it reusable by everyone.

Bat's avatar
Bat committed
86
87
88
89
### scripts

Some custom scripts, that can be run whit `poulp run`. It's an object containing the fields you want (their name will be used as the argument of `poulp run`). Each of those fields are arrays with the list of the command to run.

Bat's avatar
Bat committed
90
### dependencies
Bat's avatar
Bat committed
91

Bat's avatar
Bat committed
92
The projects dependencies. It is an object where the keys are the name of the dependencies, and the value a range of versions. The name should be the same as the VAPI file name.
Bat's avatar
Bat committed
93

Bat's avatar
Bat committed
94
To see examples of version ranges, go to [semver](https://framagit.org/Bat/semver).
Bat's avatar
Bat committed
95

Bat's avatar
Bat committed
96
### dev-dependencies
Bat's avatar
Bat committed
97

Bat's avatar
Bat committed
98
Same as `dependencies`, but will only be installed by people developing the project. For instance, it could a testing framework.
Bat's avatar
Bat committed
99

Bat's avatar
Bat committed
100
### vala-version
Bat's avatar
Bat committed
101

Bat's avatar
Bat committed
102
103
104
The minimal Vala version to use with this project.

### compiler-params
Bat's avatar
Bat committed
105
106
107

Some other arguments to gives to `valac` when building.

Bat's avatar
Bat committed
108
109
110



Bat's avatar
Bat committed
111
112
113
114
115
116
## Commands

Each command listed here can be run with `poulp command`, where `command` is the command followed by its arguments.

`[arg]` is an optional argument.

Bat's avatar
Bat committed
117
### search package
Bat's avatar
Bat committed
118
119
120
121
122
123
124
125

Search the package named `package` in the known repositories. It will display something like that.

```
package    0.1.0    Short description of the package.
other      0.2.3    Yet another package.
```

Bat's avatar
Bat committed
126
### info package
Bat's avatar
Bat committed
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

Gives infos about `package`.

```
✓ Installed

Name          package
Version       0.1.0 (latest is 0.2.0, update with `poulp update package`)
Description   This is a package.
Author        John Doe
Contributors  Jane Doe, Foo Bar

Files         package.vapi, package.h, package.so, package.pc
Dependencies  other (0.2.3), foo (<2.1.0), bar (*)
Website       https://john.doe.eu/projects/package
Source code   https://john.doe.eu/git/package.git
```

### pack [--zip|--gz]

Creates a .zip or .tar.gz file containing all the binaries of the project (.h, .vapi, .so, .dll, etc)

Bat's avatar
Bat committed
149
### publish major|minor|patch --repo url [--no-changelog]
Bat's avatar
Bat committed
150

Bat's avatar
Bat committed
151
Pack the project (see `pack` above), creates a new version (update it in the manifest, `git tag` if the project uses `git`),
Bat's avatar
Bat committed
152
153
154
155
and update the changelog with `git log`, if it was not manually done (this last behavior can be disabled with `--no-changelog`).

Then it post the new version on the repository at `url`.

Bat's avatar
Bat committed
156
157
**Warning** `--repo` and `--no-changelog` are not implemented yet.

Bat's avatar
Bat committed
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
### build [--release]

Compiles your project using the options specified in the manifest.

### gen output --template template

Creates a new file (`output`) from the template named `template`. `output` doesn't need to include any extension.

### help [command]

Gives you help about poulp, or a specific command if `command` is specified.

### init

An interactive tool to create a new project.

### install [lib] [lib] [lib]...

Install all the specified libraries, or those present in `libs` in the manifest if none.

Bat's avatar
Bat committed
178
179
It clones the libraries, checkout to the most recent matching version, builds it and installs the result.

Bat's avatar
Bat committed
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
### lint [--elementary|--gnome|--both]

Lints your code, following the specified convention (defautl is elementary).

### repo [add|remove] [url]

Manages your remote repositories. If there is no argument, it just lists them.

If you do [add url], it registers the repo at `url`. And `remove url` unregisters the repository at `url`.

### run script

It runs the script named `script`, previousy defined in the manifest.

### update [lib] [lib] [lib]...

Updates your packages to the latest version.




Bat's avatar
Bat committed
201
202
# Variables

Bat's avatar
Bat committed
203
poulp defines some environment varaibles when spawning a command. You can use them in `output`, `compiler-params` and your scripts.
Bat's avatar
Bat committed
204
205
206
207
208
209
210
211

- `$PROJECT_NAME`, the name of your project;
- `$PROJECT_VERSION`, the version of your project;
- `$PROJECT_DESCRIPTION`, the description of your project;
- `$PROJECT_LICENSE`, the license of your project;
- `$PROJECT_HOMEPAGE`, the homepage of your project;
- `$PROJECT_OUTPUT`, the path to the output of your project;

Bat's avatar
Bat committed
212
213
# Remote repositories organization

Bat's avatar
Bat committed
214
215
*You can find a sample repository [here](https://gitlab.com/Bat41/poulp-repo-test/tree/master/dist).*

Bat's avatar
Bat committed
216
The remote repositories just contains one file, named `packages.json`. It contains a list of all the packages available in this repository. It also contains another field, `name`, which is the name of the repository.
Bat's avatar
Bat committed
217

Bat's avatar
Bat committed
218
This file has an object, named `packages` which contains key-value pairs of packages (the name is the key, and the git repository the value).
Bat's avatar
Bat committed
219

Bat's avatar
Bat committed
220
*Example `package.json` file*
Bat's avatar
Bat committed
221

Bat's avatar
Bat committed
222
223
224
225
226
227
228
229
230
```
{
  "name": "A little poulp repository",
  "packages": {
    "foo": "https://git.foo.org/foo.git",
    "bar": "https://github.com/baz/bar",
    "hello": "https://gitlab.com/hey/hello"
  }
}
Bat's avatar
Bat committed
231
232
```

Bat's avatar
Bat committed
233
It is planed to make it possible for package to install templates, but not available yet.
Bat's avatar
Bat committed
234
235
236
237

----

Because it could be a little bit hard to manually manage a repository, we are [working on a web interface](https://framagit.org/valse/poulp-server) to do it easily. But yet, you can just use a git repository.
Bat's avatar
Bat committed
238
239
240



Bat's avatar
Bat committed
241
# Local organization
Bat's avatar
Bat committed
242
243
244
245
246
247

poulp stores local files in `$POULP_DATA_DIR`, which defaults to `C:\ProgramData\poulp\` on Windows and `/etc/poulp/` on other systems.

This directory contains a file named `repos`, which contains a list of all known repos (their URL to be exact), one per line.

Then, you have the `projects` and `files` folders, similar to those in a distant repository, but only with installed templates.