Pages
Introduction
Getting Started
Recipes
Reference
Literals
Arrays
Tuples
Type System
Functions
Modules
Records
Enums
Built-in Types
Constants
Equality
Stores
Routing
Comments
Control Expressions
Components
Properties
Computed Properties
Styling Elements
Connecting Stores
Using Providers
Internal State
Referencing Entities
Global Components
Lifecycle Functions
Directives
JavaScript Interop
Environment Variables
Packages
Configuration
Your application / package is configured with the
mint.json
file (which is a
JSON
file).
An example
mint.json
file of looks like this:
{
"name": "my-app",
"source-directories": [
"source"
],
"dependencies": {
"mint-codemirror": {
"repository": "https://github.com/mint-lang/mint-codemirror",
"constraint": "5.0.0 <= v < 6.0.0"
}
}
}
All the fields are validated so if something is not right you will get a nice error message!
Here are all the possible fields (dot notation denotes a nested object):
Path | Purpose |
---|---|
name
| The name of your application or package. |
source-directories
| The directories which contains source files of your application. |
test-directories
| The directories which contains tests for your application. |
dependencies
| Contains the dependencies. |
application
| Contains application specific information (can be omitted in packages) |
application.head
| A path to an HTML file which can contain links to external resources. |
application.title
| The initial title of the application. |
application.meta
| An object which contains informations which is converted to META tags. |
application.icon
| A path to an image file which is converted to different icons like [favicons](https://en.wikipedia.org/wiki/Favicon). |
application.orientation
|
[PWA] The orientation of the application, either
portrait
or
landscape
|
application.name
| [PWA] The name of the application. |
application.theme-color
| [PWA] The theme color of the application. |
application.display
|
[PWA] The display property of the application, one of:
fullscreen
standalone
minimal-ui
browser
|
formatter.indent-size
| Specifies how many spaces is used to indent code blocks. |
external.javascripts
| Specify path to the JavaScript files you want to include. |
external.stylesheets
| Specify path to the CSS files you want to include. |
Dependencies
The dependencies array contains all the packages that your application needs.
Each is an object that has a:
-
repository
field pointing to Git repository which uniquely identifies it -
constraint
field that is the version information in one of two formats:-
0.0.0 <= v < 1.0.0
where thev
is the resolvable version -
master:1.0.0
where the first part is the Git reference (of a branch, commit hash or tag) followed by a colon and the version the package should resolve as this is necessary because the version is only specified by tags.
-