@taqueria/plugin-ligo-legacy 0.40.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,165 @@
1
+ # Taqueria LIGO Plugin
2
+
3
+ The LIGO plugin provides tasks to work with LIGO smart contracts such as compiling and testing
4
+
5
+ ## Requirements
6
+
7
+ - Taqueria v0.26.0 or later
8
+ - Node.js v16.16 or later. (v17.x.x or later is not supported)
9
+ - Docker v20.10.12 or later
10
+
11
+ ## Installation
12
+
13
+ To install the LIGO plugin on a Taqueria project, navigate to the project folder and run:
14
+
15
+ ```shell
16
+ taq install @taqueria/plugin-ligo
17
+ ```
18
+
19
+ > ### :page_with_curl: Note
20
+ > You can override the Ligo version used by the plugin by creating the environment variable `TAQ_LIGO_IMAGE` and setting it to your desired Ligo Docker image
21
+
22
+ ## The `taq compile` Task
23
+
24
+ Basic usage is:
25
+
26
+ ```shell
27
+ taq compile <contractName>
28
+ ```
29
+
30
+ > ### :warning: CAUTION
31
+ > The `compile` task is implemented by more than one compiler plugin (LIGO, Archetype, SmartPy). If more than one of these plugins are installed on a project, you need to use the `--plugin ligo` flag to specify a particular compiler
32
+
33
+ ### Basic description
34
+ The LIGO plugin exposes a `compile` task in Taqueria which can target one LIGO contract in the `contracts` folder and compile them to a Michelson `.tz` file output to the `artifacts` folder
35
+
36
+ ### A frictionless smart contract development workflow
37
+ Our LIGO plugin introduces a smart contract development workflow by means of two simple file naming formats
38
+
39
+ Suppose you have a contract named `hello.mligo` and you create a file in the same directory as the contract with the naming format of `CONTRACT.storageList.EXT`, where `CONTRACT` is the name of the contract this storage list file is associated with and `EXT` must match the extension of the associated contract. In our case, the former is `hello` and the latter is `mligo`, so it'd be named `hello.storageList.mligo`
40
+
41
+ You can define a list of LIGO variables in `hello.storageList.mligo` in the form of `let VARIABLE_NAME: STORAGE_TYPE = EXPRESSION` (explicit typing is optional but recommended) and the expressions will be treated as initial storage values for `hello.mligo`
42
+
43
+ > ### :page_with_curl: Note
44
+ > Note that the form is actually mligo code. Variable definitions in other syntax variants will differ.
45
+
46
+ Similarly with `hello.parameterList.mligo` but in the form of `let VARIABLE_NAME: PARAMETER_TYPE = EXPRESSION`
47
+
48
+ `taq compile hello.storageList.mligo` will compile each definition in `hello.storageList.mligo` and will produce a Michelson `.tz` file that contains the storage value, as a Michelson expression, for each of them. If the name of a variable is `storage1`, then its emitted Michelson file will be named `hello.storage.storage1.tz`. For `taq compile hello.parameterList.mligo`, the name will be `hello.parameter.param1.tz` if there's a variable named `param1` defined in `hello.parameterList.mligo`
49
+
50
+ Furthermore, the first variable definition in `hello.storageList.mligo` will be treated as the default storage and will produce a Michelson file named `hello.default_storage.tz` instead. The `deploy` task from the Taquito plugin will take advantage of this. Go to that plugin documentation to learn how
51
+
52
+ Lastly, `taq compile hello.mligo` will compile `hello.mligo` and emit `hello.tz`. Then it'll look for `hello.storageList.mligo` and `hello.parameterList.mligo` and compile them too if they are found
53
+
54
+ ### Options
55
+
56
+ The `--json` flag will make the task emit JSON-encoded Michelson instead of pure Michelson `.tz`
57
+
58
+ ## The `taq compile-all` Task
59
+
60
+ Basic usage is:
61
+
62
+ ```shell
63
+ taq compile-all
64
+ ```
65
+
66
+ It works just like the `compile` task but it compiles all main contracts, a.k.a contracts with a `main` function.
67
+
68
+ ## The `taq test` Task
69
+
70
+ Basic usage is:
71
+
72
+ ```shell
73
+ taq test <fileName>
74
+ ```
75
+
76
+ ### Basic description
77
+ This task tests the LIGO source code and reports either a failure or success. Normally you'd have a contract file and a separate test file that includes the contract's code, both within the `contracts` directory
78
+
79
+ For example, refer to the following 2 code snippets:
80
+ ```ligo title="counter.mligo"
81
+ type storage = int
82
+
83
+ type parameter =
84
+ Increment of int
85
+ | Decrement of int
86
+ | Reset
87
+
88
+ type return = operation list * storage
89
+
90
+ // Two entrypoints
91
+
92
+ let add (store, delta : storage * int) : storage = store + delta
93
+ let sub (store, delta : storage * int) : storage = store - delta
94
+
95
+ (* Main access point that dispatches to the entrypoints according to
96
+ the smart contract parameter. *)
97
+
98
+ let main (action, store : parameter * storage) : return =
99
+ ([] : operation list), // No operations
100
+ (match action with
101
+ Increment (n) -> add (store, n)
102
+ | Decrement (n) -> sub (store, n)
103
+ | Reset -> 0)
104
+ ```
105
+
106
+ ```ligo title="testCounter.mligo"
107
+ #include "counter.mligo"
108
+
109
+ let initial_storage = 42
110
+
111
+ let test_initial_storage =
112
+ let (taddr, _, _) = Test.originate main initial_storage 0tez in
113
+ assert (Test.get_storage taddr = initial_storage)
114
+
115
+ let test_increment =
116
+ let (taddr, _, _) = Test.originate main initial_storage 0tez in
117
+ let contr = Test.to_contract taddr in
118
+ let _ = Test.transfer_to_contract_exn contr (Increment 1) 1mutez in
119
+ assert (Test.get_storage taddr = initial_storage + 1)
120
+ ```
121
+
122
+ By running `taq test testCounter.mligo`, you should get the following:
123
+ ```
124
+ ┌───────────────────┬──────────────────────────────────────────────┐
125
+ │ Contract │ Test Results │
126
+ ├───────────────────┼──────────────────────────────────────────────┤
127
+ │ testCounter.mligo │ Everything at the top-level was executed. │
128
+ │ │ - test_initial_storage exited with value (). │
129
+ │ │ - test_increment exited with value (). │
130
+ │ │ │
131
+ │ │ 🎉 All tests passed 🎉 │
132
+ └───────────────────┴──────────────────────────────────────────────┘
133
+ ```
134
+
135
+ ## The `taq ligo` task
136
+
137
+ Basic usage is:
138
+
139
+ ```shell
140
+ taq ligo --command <command to pass to the underlying LIGO binary>
141
+ ```
142
+
143
+ Wrap the value for the `--command` flag with quotes.
144
+
145
+ > ### :page_with_curl: Note
146
+ > This task allows you to run arbitrary LIGO native commands, but they might not benefit from the abstractions provided by Taqueria
147
+
148
+ ## Template creation
149
+ The LIGO plugin also exposes a contract template via the `taq create contract <contractName>` task. This task will create a new LIGO contract in the `contracts` directory and insert some boilerplate LIGO contract code
150
+
151
+ ### The `create contract` Template
152
+
153
+ The `create contract` task is used to create a new LIGO contract from a template. Running this task will create a new LIGO smart contract in the `contracts` directory and insert boilerplate contract code
154
+
155
+ ```shell
156
+ taq create contract <contractName>
157
+ ```
158
+
159
+ The `create contract` task takes a filename a required positional argument. The filename must end with a LIGO extension (`.jsligo`, `.mligo`, etc)
160
+
161
+ ## Plugin Architecture
162
+
163
+ This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
164
+
165
+ Docker is used under the hood to provide a self contained environment for LIGO to prevent the need for it to be installed on the user's local machine
package/_readme.eta ADDED
@@ -0,0 +1,171 @@
1
+ <% if (it.output == "github") { %>
2
+ # Taqueria LIGO Plugin
3
+ <% } %>
4
+
5
+ The LIGO plugin provides tasks to work with LIGO smart contracts such as compiling and testing
6
+
7
+ ## Requirements
8
+
9
+ - Taqueria v0.40.0 or later
10
+ - Node.js v18 or later
11
+ - Docker v20.10.12 or later
12
+
13
+ ## Installation
14
+
15
+ To install the LIGO plugin on a Taqueria project, navigate to the project folder and run:
16
+
17
+ ```shell
18
+ taq install @taqueria/plugin-ligo
19
+ ```
20
+
21
+ <%~ it.noteOpenAdmonition %>
22
+ You can override the Ligo version used by the plugin by creating the environment variable `TAQ_LIGO_LEGACY_IMAGE` and setting it to your desired Ligo Docker image
23
+ <%= it.closeAdmonition %>
24
+
25
+ ## The `taq compile` Task
26
+
27
+ Basic usage is:
28
+
29
+ ```shell
30
+ taq compile <contractName>
31
+ ```
32
+
33
+ <%~ it.cautionOpenAdmonition %>
34
+ The `compile` task is implemented by more than one compiler plugin (LIGO, Archetype, SmartPy). If more than one of these plugins are installed on a project, you need to use the `--plugin ligo` flag to specify a particular compiler
35
+ <%= it.closeAdmonition %>
36
+
37
+ ### Basic description
38
+ The LIGO plugin exposes a `compile` task in Taqueria which can target one LIGO contract in the `contracts` folder and compile them to a Michelson `.tz` file output to the `artifacts` folder
39
+
40
+ ### A frictionless smart contract development workflow
41
+ Our LIGO plugin introduces a smart contract development workflow by means of two simple file naming formats
42
+
43
+ Suppose you have a contract named `hello.mligo` and you create a file in the same directory as the contract with the naming format of `CONTRACT.storageList.EXT`, where `CONTRACT` is the name of the contract this storage list file is associated with and `EXT` must match the extension of the associated contract. In our case, the former is `hello` and the latter is `mligo`, so it'd be named `hello.storageList.mligo`
44
+
45
+ You can define a list of LIGO variables in `hello.storageList.mligo` in the form of `let VARIABLE_NAME: STORAGE_TYPE = EXPRESSION` (explicit typing is optional but recommended) and the expressions will be treated as initial storage values for `hello.mligo`
46
+
47
+ <%~ it.noteOpenAdmonition %>
48
+ Note that the form is actually mligo code. Variable definitions in other syntax variants will differ.
49
+ <%= it.closeAdmonition %>
50
+
51
+ Similarly with `hello.parameterList.mligo` but in the form of `let VARIABLE_NAME: PARAMETER_TYPE = EXPRESSION`
52
+
53
+ `taq compile hello.storageList.mligo` will compile each definition in `hello.storageList.mligo` and will produce a Michelson `.tz` file that contains the storage value, as a Michelson expression, for each of them. If the name of a variable is `storage1`, then its emitted Michelson file will be named `hello.storage.storage1.tz`. For `taq compile hello.parameterList.mligo`, the name will be `hello.parameter.param1.tz` if there's a variable named `param1` defined in `hello.parameterList.mligo`
54
+
55
+ Furthermore, the first variable definition in `hello.storageList.mligo` will be treated as the default storage and will produce a Michelson file named `hello.default_storage.tz` instead. The `deploy` task from the Taquito plugin will take advantage of this. Go to that plugin documentation to learn how
56
+
57
+ Lastly, `taq compile hello.mligo` will compile `hello.mligo` and emit `hello.tz`. Then it'll look for `hello.storageList.mligo` and `hello.parameterList.mligo` and compile them too if they are found
58
+
59
+ ### Options
60
+
61
+ The `--json` flag will make the task emit JSON-encoded Michelson instead of pure Michelson `.tz`
62
+
63
+ ## The `taq compile-all` Task
64
+
65
+ Basic usage is:
66
+
67
+ ```shell
68
+ taq compile-all
69
+ ```
70
+
71
+ It works just like the `compile` task but it compiles all main contracts, a.k.a contracts with a `main` function.
72
+
73
+ ## The `taq test` Task
74
+
75
+ Basic usage is:
76
+
77
+ ```shell
78
+ taq test <fileName>
79
+ ```
80
+
81
+ ### Basic description
82
+ This task tests the LIGO source code and reports either a failure or success. Normally you'd have a contract file and a separate test file that includes the contract's code, both within the `contracts` directory
83
+
84
+ For example, refer to the following 2 code snippets:
85
+ ```ligo title="counter.mligo"
86
+ type storage = int
87
+
88
+ type parameter =
89
+ Increment of int
90
+ | Decrement of int
91
+ | Reset
92
+
93
+ type return = operation list * storage
94
+
95
+ // Two entrypoints
96
+
97
+ let add (store, delta : storage * int) : storage = store + delta
98
+ let sub (store, delta : storage * int) : storage = store - delta
99
+
100
+ (* Main access point that dispatches to the entrypoints according to
101
+ the smart contract parameter. *)
102
+
103
+ let main (action, store : parameter * storage) : return =
104
+ ([] : operation list), // No operations
105
+ (match action with
106
+ Increment (n) -> add (store, n)
107
+ | Decrement (n) -> sub (store, n)
108
+ | Reset -> 0)
109
+ ```
110
+
111
+ ```ligo title="testCounter.mligo"
112
+ #include "counter.mligo"
113
+
114
+ let initial_storage = 42
115
+
116
+ let test_initial_storage =
117
+ let (taddr, _, _) = Test.originate main initial_storage 0tez in
118
+ assert (Test.get_storage taddr = initial_storage)
119
+
120
+ let test_increment =
121
+ let (taddr, _, _) = Test.originate main initial_storage 0tez in
122
+ let contr = Test.to_contract taddr in
123
+ let _ = Test.transfer_to_contract_exn contr (Increment 1) 1mutez in
124
+ assert (Test.get_storage taddr = initial_storage + 1)
125
+ ```
126
+
127
+ By running `taq test testCounter.mligo`, you should get the following:
128
+ ```
129
+ ┌───────────────────┬──────────────────────────────────────────────┐
130
+ │ Contract │ Test Results │
131
+ ├───────────────────┼──────────────────────────────────────────────┤
132
+ │ testCounter.mligo │ Everything at the top-level was executed. │
133
+ │ │ - test_initial_storage exited with value (). │
134
+ │ │ - test_increment exited with value (). │
135
+ │ │ │
136
+ │ │ 🎉 All tests passed 🎉 │
137
+ └───────────────────┴──────────────────────────────────────────────┘
138
+ ```
139
+
140
+ ## The `taq ligo` task
141
+
142
+ Basic usage is:
143
+
144
+ ```shell
145
+ taq ligo --command <command to pass to the underlying LIGO binary>
146
+ ```
147
+
148
+ Wrap the value for the `--command` flag with quotes.
149
+
150
+ <%~ it.noteOpenAdmonition %>
151
+ This task allows you to run arbitrary LIGO native commands, but they might not benefit from the abstractions provided by Taqueria
152
+ <%= it.closeAdmonition %>
153
+
154
+ ## Template creation
155
+ The LIGO plugin also exposes a contract template via the `taq create contract <contractName>` task. This task will create a new LIGO contract in the `contracts` directory and insert some boilerplate LIGO contract code
156
+
157
+ ### The `create contract` Template
158
+
159
+ The `create contract` task is used to create a new LIGO contract from a template. Running this task will create a new LIGO smart contract in the `contracts` directory and insert boilerplate contract code
160
+
161
+ ```shell
162
+ taq create contract <contractName>
163
+ ```
164
+
165
+ The `create contract` task takes a filename a required positional argument. The filename must end with a LIGO extension (`.jsligo`, `.mligo`, etc)
166
+
167
+ ## Plugin Architecture
168
+
169
+ This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
170
+
171
+ Docker is used under the hood to provide a self contained environment for LIGO to prevent the need for it to be installed on the user's local machine
package/index.d.ts ADDED
@@ -0,0 +1,2 @@
1
+
2
+ export { }
package/index.js ADDED
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+
3
+ // index.ts
4
+ var import_lib_ligo = require("@taqueria/lib-ligo");
5
+ (0, import_lib_ligo.configurePlugin)({
6
+ name: "@taqueria/plugin-ligo-legacy",
7
+ alias: "ligo-legacy",
8
+ dockerImage: "ligolang/ligo:0.73.0",
9
+ dockerImageEnvVar: "TAQ_LIGO_LEGACY_IMAGE",
10
+ unparsedArgs: process.argv
11
+ });
12
+ //# sourceMappingURL=index.js.map
package/index.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["index.ts"],"sourcesContent":["import {configurePlugin} from \"@taqueria/lib-ligo\"\n\nconfigurePlugin({\n name: '@taqueria/plugin-ligo-legacy',\n alias: \"ligo-legacy\",\n dockerImage: \"ligolang/ligo:0.73.0\",\n dockerImageEnvVar: \"TAQ_LIGO_LEGACY_IMAGE\",\n unparsedArgs: process.argv\n})"],"mappings":";;;AAAA,sBAA8B;AAAA,IAE9B,iCAAgB;AAAA,EACZ,MAAM;AAAA,EACN,OAAO;AAAA,EACP,aAAa;AAAA,EACb,mBAAmB;AAAA,EACnB,cAAc,QAAQ;AAC1B,CAAC;","names":[]}
package/index.mjs ADDED
@@ -0,0 +1,10 @@
1
+ // index.ts
2
+ import { configurePlugin } from "@taqueria/lib-ligo";
3
+ configurePlugin({
4
+ name: "@taqueria/plugin-ligo-legacy",
5
+ alias: "ligo-legacy",
6
+ dockerImage: "ligolang/ligo:0.73.0",
7
+ dockerImageEnvVar: "TAQ_LIGO_LEGACY_IMAGE",
8
+ unparsedArgs: process.argv
9
+ });
10
+ //# sourceMappingURL=index.mjs.map
package/index.mjs.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["index.ts"],"sourcesContent":["import {configurePlugin} from \"@taqueria/lib-ligo\"\n\nconfigurePlugin({\n name: '@taqueria/plugin-ligo-legacy',\n alias: \"ligo-legacy\",\n dockerImage: \"ligolang/ligo:0.73.0\",\n dockerImageEnvVar: \"TAQ_LIGO_LEGACY_IMAGE\",\n unparsedArgs: process.argv\n})"],"mappings":";AAAA,SAAQ,uBAAsB;AAE9B,gBAAgB;AAAA,EACZ,MAAM;AAAA,EACN,OAAO;AAAA,EACP,aAAa;AAAA,EACb,mBAAmB;AAAA,EACnB,cAAc,QAAQ;AAC1B,CAAC;","names":[]}
package/index.ts ADDED
@@ -0,0 +1,9 @@
1
+ import { configurePlugin } from '@taqueria/lib-ligo';
2
+
3
+ configurePlugin({
4
+ name: '@taqueria/plugin-ligo-legacy',
5
+ alias: 'ligo-legacy',
6
+ dockerImage: 'ligolang/ligo:0.73.0',
7
+ dockerImageEnvVar: 'TAQ_LIGO_LEGACY_IMAGE',
8
+ unparsedArgs: process.argv,
9
+ });
package/package.json ADDED
@@ -0,0 +1,69 @@
1
+ {
2
+ "name": "@taqueria/plugin-ligo-legacy",
3
+ "version": "0.40.10",
4
+ "description": "A taqueria plugin for compiling LIGO smart contracts that target LIGO v0.73.0 and earlier.",
5
+ "targets": {
6
+ "default": {
7
+ "source": "./index.ts",
8
+ "distDir": "./",
9
+ "context": "node",
10
+ "isLibrary": true
11
+ }
12
+ },
13
+ "scripts": {
14
+ "test": "echo \"Error: no test specified\" && exit 1",
15
+ "build": "npx tsc -noEmit -p ./tsconfig.json && npx tsup",
16
+ "pluginInfo": "npx ts-node index.ts --taqRun pluginInfo --i18n '{\"foo\":\"bar\"}' --config '{\"contractsDir\":\"contracts\",\"testsDir\": \"tests\",\"artifactsDir\": \"artifacts\"}' --projectDir ../test-project --configDir ./.taq",
17
+ "compile": "npx ts-node index.ts --taqRun proxy --task compile --i18n '{\"foo\":\"bar\"}' --config '{\"contractsDir\":\"contracts\",\"testsDir\": \"tests\",\"artifactsDir\": \"artifacts\"}' --projectDir ../test-project --configDir ./.taq",
18
+ "debugPluginInfo": "npx ts-node --inspect index.ts --taqRun pluginInfo --i18n '{\"foo\":\"bar\"}' --config '{\"contractsDir\":\"contracts\",\"testsDir\": \"tests\"}' --projectDir ../test-project --configDir ./.taq"
19
+ },
20
+ "keywords": [
21
+ "taqueria",
22
+ "tezos",
23
+ "build",
24
+ "pinnaclelabs",
25
+ "pinnacle-labs",
26
+ "plugin",
27
+ "ligo",
28
+ "ligolang",
29
+ "smart contract",
30
+ "compile"
31
+ ],
32
+ "author": "Pinnacle Labs",
33
+ "license": "Apache-2.0",
34
+ "repository": {
35
+ "type": "git",
36
+ "url": "git+https://github.com/pinnacle-labs/taqueria.git",
37
+ "directory": "taqueria-plugin-ligo"
38
+ },
39
+ "bugs": {
40
+ "url": "https://github.com/pinnacle-labs/taqueria/issues"
41
+ },
42
+ "homepage": "https://github.com/pinnacle-labs/taqueria#readme",
43
+ "dependencies": {
44
+ "@taqueria/lib-ligo": "^0.40.10",
45
+ "@taqueria/node-sdk": "^0.40.10",
46
+ "fast-glob": "^3.3.1"
47
+ },
48
+ "devDependencies": {
49
+ "tsup": "^7.2.0",
50
+ "typescript": "^5.2.2"
51
+ },
52
+ "tsup": {
53
+ "entry": [
54
+ "index.ts"
55
+ ],
56
+ "sourcemap": true,
57
+ "target": "node16",
58
+ "outDir": "./",
59
+ "dts": true,
60
+ "clean": false,
61
+ "skipNodeModulesBundle": true,
62
+ "platform": "node",
63
+ "format": [
64
+ "esm",
65
+ "cjs"
66
+ ]
67
+ },
68
+ "gitHead": "ff58a2fc06ad233869ad6be574093c8b3b272e2e"
69
+ }
package/tsconfig.json ADDED
@@ -0,0 +1,103 @@
1
+ {
2
+ "compilerOptions": {
3
+ /* Visit https://aka.ms/tsconfig.json to read more about this file */
4
+
5
+ /* Projects */
6
+ // "incremental": true, /* Enable incremental compilation */
7
+ // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
8
+ // "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */
9
+ // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */
10
+ // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
11
+ // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
12
+
13
+ /* Language and Environment */
14
+ "target": "ES2021", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
15
+ "lib": [
16
+ "ES2021.String"
17
+ ], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
18
+ // "jsx": "preserve", /* Specify what JSX code is generated. */
19
+ // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
20
+ // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
21
+ // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
22
+ // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
23
+ // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
24
+ // "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
25
+ // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
26
+ // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
27
+
28
+ /* Modules */
29
+ "module": "CommonJS", /* Specify what module code is generated. */
30
+ // "rootDir": "./", /* Specify the root folder within your source files. */
31
+ // "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
32
+ // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
33
+ // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
34
+ // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
35
+ // "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */
36
+ // "types": [], /* Specify type package names to be included without being referenced in a source file. */
37
+ // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
38
+ // "resolveJsonModule": true, /* Enable importing .json files */
39
+ // "noResolve": true, /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
40
+
41
+ /* JavaScript Support */
42
+ // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
43
+ // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
44
+ // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
45
+
46
+ /* Emit */
47
+ "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
48
+ // "declarationMap": true, /* Create sourcemaps for d.ts files. */
49
+ // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
50
+ // "sourceMap": true, /* Create source map files for emitted JavaScript files. */
51
+ // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
52
+ // "outDir": "./", /* Specify an output folder for all emitted files. */
53
+ // "removeComments": true, /* Disable emitting comments. */
54
+ // "noEmit": true, /* Disable emitting files from a compilation. */
55
+ // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
56
+ // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */
57
+ // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
58
+ // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
59
+ // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
60
+ // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
61
+ // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
62
+ // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
63
+ // "newLine": "crlf", /* Set the newline character for emitting files. */
64
+ // "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
65
+ // "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */
66
+ // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
67
+ // "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */
68
+ // "declarationDir": "./", /* Specify the output directory for generated declaration files. */
69
+ // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
70
+
71
+ /* Interop Constraints */
72
+ "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
73
+ "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
74
+ "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
75
+ // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
76
+ "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
77
+
78
+ /* Type Checking */
79
+ "strict": true, /* Enable all strict type-checking options. */
80
+ // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */
81
+ // "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */
82
+ // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
83
+ // "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
84
+ // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
85
+ // "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */
86
+ // "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */
87
+ // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
88
+ // "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */
89
+ // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */
90
+ // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
91
+ // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
92
+ // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
93
+ // "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
94
+ // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
95
+ // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */
96
+ // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
97
+ // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
98
+
99
+ /* Completeness */
100
+ // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
101
+ "skipLibCheck": true /* Skip type checking all .d.ts files. */
102
+ }
103
+ }