knex 2.5.0 → 2.5.1

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.
Files changed (167) hide show
  1. package/CHANGELOG.md +64 -58
  2. package/CONTRIBUTING.md +194 -194
  3. package/README.md +149 -147
  4. package/UPGRADING.md +245 -233
  5. package/bin/cli.js +475 -473
  6. package/bin/utils/cli-config-utils.js +212 -210
  7. package/bin/utils/constants.js +7 -7
  8. package/bin/utils/migrationsLister.js +37 -37
  9. package/knex.js +23 -23
  10. package/knex.mjs +11 -11
  11. package/lib/builder-interface-augmenter.js +120 -120
  12. package/lib/client.js +495 -495
  13. package/lib/constants.js +61 -61
  14. package/lib/dialects/better-sqlite3/index.js +77 -77
  15. package/lib/dialects/cockroachdb/crdb-columncompiler.js +14 -14
  16. package/lib/dialects/cockroachdb/crdb-querybuilder.js +11 -11
  17. package/lib/dialects/cockroachdb/crdb-querycompiler.js +122 -122
  18. package/lib/dialects/cockroachdb/crdb-tablecompiler.js +37 -37
  19. package/lib/dialects/cockroachdb/crdb-viewcompiler.js +15 -15
  20. package/lib/dialects/cockroachdb/index.js +86 -86
  21. package/lib/dialects/index.js +20 -20
  22. package/lib/dialects/mssql/index.js +500 -500
  23. package/lib/dialects/mssql/mssql-formatter.js +34 -34
  24. package/lib/dialects/mssql/query/mssql-querycompiler.js +601 -601
  25. package/lib/dialects/mssql/schema/mssql-columncompiler.js +185 -185
  26. package/lib/dialects/mssql/schema/mssql-compiler.js +91 -91
  27. package/lib/dialects/mssql/schema/mssql-tablecompiler.js +378 -378
  28. package/lib/dialects/mssql/schema/mssql-viewcompiler.js +55 -55
  29. package/lib/dialects/mssql/transaction.js +176 -176
  30. package/lib/dialects/mysql/index.js +201 -201
  31. package/lib/dialects/mysql/query/mysql-querycompiler.js +274 -274
  32. package/lib/dialects/mysql/schema/mysql-columncompiler.js +193 -193
  33. package/lib/dialects/mysql/schema/mysql-compiler.js +60 -60
  34. package/lib/dialects/mysql/schema/mysql-tablecompiler.js +381 -381
  35. package/lib/dialects/mysql/schema/mysql-viewbuilder.js +21 -21
  36. package/lib/dialects/mysql/schema/mysql-viewcompiler.js +15 -15
  37. package/lib/dialects/mysql/transaction.js +46 -46
  38. package/lib/dialects/mysql2/index.js +53 -53
  39. package/lib/dialects/mysql2/transaction.js +44 -44
  40. package/lib/dialects/oracle/DEAD_CODE.md +5 -5
  41. package/lib/dialects/oracle/index.js +92 -92
  42. package/lib/dialects/oracle/query/oracle-querycompiler.js +343 -343
  43. package/lib/dialects/oracle/schema/internal/incrementUtils.js +20 -20
  44. package/lib/dialects/oracle/schema/internal/trigger.js +135 -135
  45. package/lib/dialects/oracle/schema/oracle-columnbuilder.js +17 -17
  46. package/lib/dialects/oracle/schema/oracle-columncompiler.js +126 -126
  47. package/lib/dialects/oracle/schema/oracle-compiler.js +122 -122
  48. package/lib/dialects/oracle/schema/oracle-tablecompiler.js +190 -190
  49. package/lib/dialects/oracle/utils.js +87 -87
  50. package/lib/dialects/oracledb/index.js +327 -327
  51. package/lib/dialects/oracledb/query/oracledb-querycompiler.js +481 -481
  52. package/lib/dialects/oracledb/schema/oracledb-columncompiler.js +61 -61
  53. package/lib/dialects/oracledb/schema/oracledb-tablecompiler.js +19 -19
  54. package/lib/dialects/oracledb/schema/oracledb-viewbuilder.js +13 -13
  55. package/lib/dialects/oracledb/schema/oracledb-viewcompiler.js +19 -19
  56. package/lib/dialects/oracledb/transaction.js +98 -98
  57. package/lib/dialects/oracledb/utils.js +208 -208
  58. package/lib/dialects/pgnative/index.js +60 -60
  59. package/lib/dialects/postgres/execution/pg-transaction.js +19 -19
  60. package/lib/dialects/postgres/index.js +358 -358
  61. package/lib/dialects/postgres/query/pg-querybuilder.js +43 -43
  62. package/lib/dialects/postgres/query/pg-querycompiler.js +400 -400
  63. package/lib/dialects/postgres/schema/pg-columncompiler.js +156 -156
  64. package/lib/dialects/postgres/schema/pg-compiler.js +138 -138
  65. package/lib/dialects/postgres/schema/pg-tablecompiler.js +304 -304
  66. package/lib/dialects/postgres/schema/pg-viewbuilder.js +21 -21
  67. package/lib/dialects/postgres/schema/pg-viewcompiler.js +35 -35
  68. package/lib/dialects/redshift/index.js +86 -86
  69. package/lib/dialects/redshift/query/redshift-querycompiler.js +163 -163
  70. package/lib/dialects/redshift/schema/redshift-columnbuilder.js +22 -22
  71. package/lib/dialects/redshift/schema/redshift-columncompiler.js +67 -67
  72. package/lib/dialects/redshift/schema/redshift-compiler.js +14 -14
  73. package/lib/dialects/redshift/schema/redshift-tablecompiler.js +122 -122
  74. package/lib/dialects/redshift/schema/redshift-viewcompiler.js +11 -11
  75. package/lib/dialects/redshift/transaction.js +32 -32
  76. package/lib/dialects/sqlite3/execution/sqlite-transaction.js +25 -25
  77. package/lib/dialects/sqlite3/index.js +250 -250
  78. package/lib/dialects/sqlite3/query/sqlite-querybuilder.js +33 -33
  79. package/lib/dialects/sqlite3/query/sqlite-querycompiler.js +334 -334
  80. package/lib/dialects/sqlite3/schema/ddl.js +400 -400
  81. package/lib/dialects/sqlite3/schema/internal/compiler.js +327 -327
  82. package/lib/dialects/sqlite3/schema/internal/parser-combinator.js +161 -161
  83. package/lib/dialects/sqlite3/schema/internal/parser.js +638 -638
  84. package/lib/dialects/sqlite3/schema/internal/sqlite-ddl-operations.js +41 -41
  85. package/lib/dialects/sqlite3/schema/internal/tokenizer.js +38 -38
  86. package/lib/dialects/sqlite3/schema/internal/utils.js +12 -12
  87. package/lib/dialects/sqlite3/schema/sqlite-columncompiler.js +50 -50
  88. package/lib/dialects/sqlite3/schema/sqlite-compiler.js +80 -80
  89. package/lib/dialects/sqlite3/schema/sqlite-tablecompiler.js +347 -347
  90. package/lib/dialects/sqlite3/schema/sqlite-viewcompiler.js +40 -40
  91. package/lib/execution/batch-insert.js +51 -51
  92. package/lib/execution/internal/delay.js +6 -6
  93. package/lib/execution/internal/ensure-connection-callback.js +41 -41
  94. package/lib/execution/internal/query-executioner.js +62 -62
  95. package/lib/execution/runner.js +325 -325
  96. package/lib/execution/transaction.js +409 -409
  97. package/lib/formatter/formatterUtils.js +42 -42
  98. package/lib/formatter/rawFormatter.js +84 -84
  99. package/lib/formatter/wrappingFormatter.js +250 -250
  100. package/lib/formatter.js +25 -25
  101. package/lib/index.js +3 -3
  102. package/lib/knex-builder/FunctionHelper.js +80 -80
  103. package/lib/knex-builder/Knex.js +59 -59
  104. package/lib/knex-builder/internal/config-resolver.js +57 -57
  105. package/lib/knex-builder/internal/parse-connection.js +87 -87
  106. package/lib/knex-builder/make-knex.js +345 -345
  107. package/lib/logger.js +76 -76
  108. package/lib/migrations/common/MigrationsLoader.js +36 -36
  109. package/lib/migrations/migrate/MigrationGenerator.js +84 -84
  110. package/lib/migrations/migrate/Migrator.js +598 -598
  111. package/lib/migrations/migrate/migrate-stub.js +17 -17
  112. package/lib/migrations/migrate/migration-list-resolver.js +33 -33
  113. package/lib/migrations/migrate/migrator-configuration-merger.js +58 -58
  114. package/lib/migrations/migrate/sources/fs-migrations.js +74 -74
  115. package/lib/migrations/migrate/table-creator.js +77 -77
  116. package/lib/migrations/migrate/table-resolver.js +27 -27
  117. package/lib/migrations/seed/Seeder.js +137 -137
  118. package/lib/migrations/seed/seed-stub.js +13 -13
  119. package/lib/migrations/seed/seeder-configuration-merger.js +60 -60
  120. package/lib/migrations/seed/sources/fs-seeds.js +65 -65
  121. package/lib/migrations/util/fs.js +86 -86
  122. package/lib/migrations/util/import-file.js +12 -12
  123. package/lib/migrations/util/is-module-type.js +9 -9
  124. package/lib/migrations/util/template.js +52 -52
  125. package/lib/migrations/util/timestamp.js +14 -14
  126. package/lib/query/analytic.js +52 -52
  127. package/lib/query/constants.js +15 -15
  128. package/lib/query/joinclause.js +270 -270
  129. package/lib/query/method-constants.js +136 -136
  130. package/lib/query/querybuilder.js +1793 -1793
  131. package/lib/query/querycompiler.js +1591 -1591
  132. package/lib/raw.js +139 -139
  133. package/lib/ref.js +39 -39
  134. package/lib/schema/builder.js +115 -115
  135. package/lib/schema/columnbuilder.js +146 -146
  136. package/lib/schema/columncompiler.js +307 -307
  137. package/lib/schema/compiler.js +187 -187
  138. package/lib/schema/internal/helpers.js +55 -55
  139. package/lib/schema/tablebuilder.js +376 -376
  140. package/lib/schema/tablecompiler.js +433 -433
  141. package/lib/schema/viewbuilder.js +92 -92
  142. package/lib/schema/viewcompiler.js +138 -138
  143. package/lib/util/finally-mixin.js +13 -13
  144. package/lib/util/helpers.js +95 -95
  145. package/lib/util/is.js +32 -32
  146. package/lib/util/nanoid.js +40 -40
  147. package/lib/util/noop.js +1 -1
  148. package/lib/util/save-async-stack.js +14 -14
  149. package/lib/util/security.js +26 -26
  150. package/lib/util/string.js +190 -190
  151. package/lib/util/timeout.js +29 -29
  152. package/package.json +11 -10
  153. package/scripts/build.js +125 -125
  154. package/scripts/clean.js +31 -31
  155. package/scripts/docker-compose.yml +152 -152
  156. package/scripts/next-release-howto.md +24 -24
  157. package/scripts/release.sh +2 -0
  158. package/scripts/runkit-example.js +35 -34
  159. package/scripts/stress-test/docker-compose.yml +57 -57
  160. package/scripts/stress-test/knex-stress-test.js +212 -208
  161. package/scripts/stress-test/mysql2-random-hanging-every-now-and-then.js +149 -145
  162. package/scripts/stress-test/mysql2-sudden-exit-without-error.js +101 -100
  163. package/scripts/stress-test/reconnect-test-mysql-based-drivers.js +188 -184
  164. package/scripts/update_gitignore_for_tsc_output.js +90 -90
  165. package/types/index.d.ts +3274 -3273
  166. package/types/result.d.ts +27 -27
  167. package/types/tables.d.ts +4 -4
@@ -1,184 +1,188 @@
1
- /**
2
- * Test case for figuring out robust way to recognize if connection is dead
3
- * for mysql based drivers.
4
- */
5
- const delay = require('../../lib/execution/internal/delay');
6
- const toxiproxy = require('toxiproxy-node-client');
7
- const toxicli = new toxiproxy.Toxiproxy('http://localhost:8474');
8
- const rp = require('request-promise-native');
9
-
10
- async function stdMysqlQuery(con, sql) {
11
- return new Promise((resolve, reject) => {
12
- try {
13
- con.query(
14
- {
15
- sql,
16
- timeout: 4000,
17
- },
18
- function (error, results, fields) {
19
- if (error) {
20
- reject(error);
21
- } else {
22
- resolve(results);
23
- }
24
- }
25
- );
26
- } catch (err) {
27
- reject(err); // double sure...
28
- }
29
- });
30
- }
31
-
32
- // ALL THE DRIVERS HAS DIFFERENT BAG OF TRICKS TO RECOVER AND
33
- // RECOGNIZE WHEN CONNECTION HAS BEEN CLOSED
34
-
35
- // ------------- setup mysql db driver connection
36
- const mysql = require('mysql');
37
- let mysqlCon = { state: 'disconnected' };
38
- async function mysqlQuery(sql) {
39
- // best way to check if connection is still alive
40
- if (mysqlCon.state === 'disconnected') {
41
- console.log('reconnecting mysql');
42
- mysqlCon = mysql.createConnection({
43
- host: 'localhost',
44
- user: 'root',
45
- password: 'mysqlrootpassword',
46
- port: 23306,
47
- connectTimeout: 500,
48
- });
49
- // not always triggered, if this happens during query
50
- mysqlCon.on('error', (err) => {
51
- console.log('- STATS Mysql connection died:', err);
52
- });
53
- }
54
- return stdMysqlQuery(mysqlCon, sql);
55
- }
56
-
57
- // ------------- setup mysql2 db driver connection
58
- const mysql2 = require('mysql2');
59
- let mysql2Con = { _fatalError: 'initmefirst' };
60
- async function mysql2Query(sql) {
61
- if (mysql2Con._fatalError) {
62
- console.log('reconnecting mysql2');
63
- mysql2Con = mysql2.createConnection({
64
- host: 'localhost',
65
- user: 'root',
66
- password: 'mysqlrootpassword',
67
- port: 23306,
68
- connectTimeout: 500,
69
- });
70
- mysql2Con.on('error', (err) => {
71
- console.log('- STATS Mysql2 connection died:', err);
72
- });
73
- }
74
- console.log('================ MYSQL2 Running query....');
75
- const res = await stdMysqlQuery(mysql2Con, sql);
76
- console.log('=========== done');
77
- return res;
78
- }
79
-
80
- const counters = {};
81
- function setMysqlQueryCounters(name) {
82
- const counts = (counters[name] = { queries: 0, results: 0, errors: 0 });
83
- }
84
- setMysqlQueryCounters('mysql');
85
- setMysqlQueryCounters('mysql2');
86
-
87
- const _ = require('lodash');
88
-
89
- // start printing out counters
90
- let lastCounters = _.cloneDeep(counters);
91
-
92
- setInterval(() => {
93
- const reqsPerSec = {};
94
- for (let key of Object.keys(counters)) {
95
- reqsPerSec[key] = {
96
- queries: counters[key].queries - lastCounters[key].queries,
97
- results: counters[key].results - lastCounters[key].results,
98
- errors: counters[key].errors - lastCounters[key].errors,
99
- };
100
- }
101
- console.log(
102
- '------------------------ STATS PER SECOND ------------------------'
103
- );
104
- console.dir(reqsPerSec, { colors: true });
105
- console.log(
106
- '------------------------------- EOS ------------------------------'
107
- );
108
- lastCounters = _.cloneDeep(counters);
109
-
110
- // if hang
111
- ///if (reqsPerSec.mysql2.queries === 0) process.exit(0);
112
- }, 1000);
113
-
114
- async function main() {
115
- async function recreateProxy(serviceName, listenPort, proxyToPort) {
116
- try {
117
- await rp.delete({
118
- url: `${toxicli.host}/proxies/${serviceName}`,
119
- });
120
- } catch (err) {}
121
-
122
- const proxy = await toxicli.createProxy({
123
- name: serviceName,
124
- listen: `0.0.0.0:${listenPort}`,
125
- upstream: `${serviceName}:${proxyToPort}`,
126
- });
127
-
128
- // add some latency
129
- await proxy.addToxic(
130
- new toxiproxy.Toxic(proxy, {
131
- type: 'latency',
132
- attributes: { latency: 1, jitter: 1 },
133
- })
134
- );
135
-
136
- // cause connections to be closed every some transferred bytes
137
- await proxy.addToxic(
138
- new toxiproxy.Toxic(proxy, {
139
- type: 'limit_data',
140
- attributes: { bytes: 1000 },
141
- })
142
- );
143
- }
144
-
145
- // create TCP proxies for simulating bad connections etc.
146
- async function recreateProxies() {
147
- console.log('----- Recreating proxies -> cutting connections completely');
148
- await recreateProxy('postgresql', 25432, 5432);
149
- await recreateProxy('mysql', 23306, 3306);
150
- await recreateProxy('oracledb', 21521, 1521);
151
- }
152
- setInterval(() => recreateProxies(), 2000);
153
-
154
- async function loopQueries(prefix, query) {
155
- const counts = counters[prefix];
156
-
157
- while (true) {
158
- try {
159
- counts.queries += 1;
160
- // without this delay we endup to busy failure loop
161
- await delay(0);
162
- await query();
163
- counts.results += 1;
164
- } catch (err) {
165
- counts.errors += 1;
166
- console.log(prefix, err);
167
- }
168
- }
169
- }
170
-
171
- await recreateProxies();
172
-
173
- loopQueries('mysql', () => mysqlQuery('select 1'));
174
- loopQueries('mysql2', () => mysql2Query('select 1'));
175
-
176
- // wait forever
177
- while (true) {
178
- await delay(1000);
179
- }
180
- }
181
-
182
- main()
183
- .then(() => console.log('DONE'))
184
- .catch((err) => console.log(err));
1
+ /**
2
+ * Test case for figuring out robust way to recognize if connection is dead
3
+ * for mysql based drivers.
4
+ */
5
+ const delay = require('../../lib/execution/internal/delay');
6
+ const toxiproxy = require('toxiproxy-node-client');
7
+ const toxicli = new toxiproxy.Toxiproxy('http://localhost:8474');
8
+ const rp = require('request-promise-native');
9
+
10
+ async function stdMysqlQuery(con, sql) {
11
+ return new Promise((resolve, reject) => {
12
+ try {
13
+ con.query(
14
+ {
15
+ sql,
16
+ timeout: 4000,
17
+ },
18
+ function (error, results, fields) {
19
+ if (error) {
20
+ reject(error);
21
+ } else {
22
+ resolve(results);
23
+ }
24
+ }
25
+ );
26
+ } catch (err) {
27
+ reject(err); // double sure...
28
+ }
29
+ });
30
+ }
31
+
32
+ // ALL THE DRIVERS HAS DIFFERENT BAG OF TRICKS TO RECOVER AND
33
+ // RECOGNIZE WHEN CONNECTION HAS BEEN CLOSED
34
+
35
+ // ------------- setup mysql db driver connection
36
+ const mysql = require('mysql');
37
+ let mysqlCon = { state: 'disconnected' };
38
+ async function mysqlQuery(sql) {
39
+ // best way to check if connection is still alive
40
+ if (mysqlCon.state === 'disconnected') {
41
+ console.log('reconnecting mysql');
42
+ mysqlCon = mysql.createConnection({
43
+ host: 'localhost',
44
+ user: 'root',
45
+ password: 'mysqlrootpassword',
46
+ port: 23306,
47
+ connectTimeout: 500,
48
+ });
49
+ // not always triggered, if this happens during query
50
+ mysqlCon.on('error', (err) => {
51
+ console.log('- STATS Mysql connection died:', err);
52
+ });
53
+ }
54
+ return stdMysqlQuery(mysqlCon, sql);
55
+ }
56
+
57
+ // ------------- setup mysql2 db driver connection
58
+ const mysql2 = require('mysql2');
59
+ let mysql2Con = { _fatalError: 'initmefirst' };
60
+ async function mysql2Query(sql) {
61
+ if (mysql2Con._fatalError) {
62
+ console.log('reconnecting mysql2');
63
+ mysql2Con = mysql2.createConnection({
64
+ host: 'localhost',
65
+ user: 'root',
66
+ password: 'mysqlrootpassword',
67
+ port: 23306,
68
+ connectTimeout: 500,
69
+ });
70
+ mysql2Con.on('error', (err) => {
71
+ console.log('- STATS Mysql2 connection died:', err);
72
+ });
73
+ }
74
+ console.log('================ MYSQL2 Running query....');
75
+ const res = await stdMysqlQuery(mysql2Con, sql);
76
+ console.log('=========== done');
77
+ return res;
78
+ }
79
+
80
+ const counters = {};
81
+ function setMysqlQueryCounters(name) {
82
+ counters[name] = { queries: 0, results: 0, errors: 0 };
83
+ }
84
+ setMysqlQueryCounters('mysql');
85
+ setMysqlQueryCounters('mysql2');
86
+
87
+ const _ = require('lodash');
88
+
89
+ // start printing out counters
90
+ let lastCounters = _.cloneDeep(counters);
91
+
92
+ setInterval(() => {
93
+ const reqsPerSec = {};
94
+ for (const key of Object.keys(counters)) {
95
+ reqsPerSec[key] = {
96
+ queries: counters[key].queries - lastCounters[key].queries,
97
+ results: counters[key].results - lastCounters[key].results,
98
+ errors: counters[key].errors - lastCounters[key].errors,
99
+ };
100
+ }
101
+ console.log(
102
+ '------------------------ STATS PER SECOND ------------------------'
103
+ );
104
+ console.dir(reqsPerSec, { colors: true });
105
+ console.log(
106
+ '------------------------------- EOS ------------------------------'
107
+ );
108
+ lastCounters = _.cloneDeep(counters);
109
+
110
+ // if hang
111
+ ///if (reqsPerSec.mysql2.queries === 0) process.exit(0);
112
+ }, 1000);
113
+
114
+ async function main() {
115
+ async function recreateProxy(serviceName, listenPort, proxyToPort) {
116
+ try {
117
+ await rp.delete({
118
+ url: `${toxicli.host}/proxies/${serviceName}`,
119
+ });
120
+ } catch (err) {
121
+ /* empty */
122
+ }
123
+
124
+ const proxy = await toxicli.createProxy({
125
+ name: serviceName,
126
+ listen: `0.0.0.0:${listenPort}`,
127
+ upstream: `${serviceName}:${proxyToPort}`,
128
+ });
129
+
130
+ // add some latency
131
+ await proxy.addToxic(
132
+ new toxiproxy.Toxic(proxy, {
133
+ type: 'latency',
134
+ attributes: { latency: 1, jitter: 1 },
135
+ })
136
+ );
137
+
138
+ // cause connections to be closed every some transferred bytes
139
+ await proxy.addToxic(
140
+ new toxiproxy.Toxic(proxy, {
141
+ type: 'limit_data',
142
+ attributes: { bytes: 1000 },
143
+ })
144
+ );
145
+ }
146
+
147
+ // create TCP proxies for simulating bad connections etc.
148
+ async function recreateProxies() {
149
+ console.log('----- Recreating proxies -> cutting connections completely');
150
+ await recreateProxy('postgresql', 25432, 5432);
151
+ await recreateProxy('mysql', 23306, 3306);
152
+ await recreateProxy('oracledb', 21521, 1521);
153
+ }
154
+ setInterval(() => recreateProxies(), 2000);
155
+
156
+ async function loopQueries(prefix, query) {
157
+ const counts = counters[prefix];
158
+
159
+ // eslint-disable-next-line no-constant-condition
160
+ while (true) {
161
+ try {
162
+ counts.queries += 1;
163
+ // without this delay we endup to busy failure loop
164
+ await delay(0);
165
+ await query();
166
+ counts.results += 1;
167
+ } catch (err) {
168
+ counts.errors += 1;
169
+ console.log(prefix, err);
170
+ }
171
+ }
172
+ }
173
+
174
+ await recreateProxies();
175
+
176
+ loopQueries('mysql', () => mysqlQuery('select 1'));
177
+ loopQueries('mysql2', () => mysql2Query('select 1'));
178
+
179
+ // wait forever
180
+ // eslint-disable-next-line no-constant-condition
181
+ while (true) {
182
+ await delay(1000);
183
+ }
184
+ }
185
+
186
+ main()
187
+ .then(() => console.log('DONE'))
188
+ .catch((err) => console.log(err));
@@ -1,90 +1,90 @@
1
- #!/usr/bin/env node
2
-
3
- const path = require('path');
4
- const fs = require('fs');
5
-
6
- // Directory constants
7
- const scriptDirectory = __dirname;
8
- const repoDirectory = path.join(scriptDirectory, '..');
9
- const libDirectory = path.join(repoDirectory, 'lib');
10
-
11
- const helpText = `
12
- Helper script to update lib/.gitignore for all .js files from .ts files.
13
-
14
- update_gitignore_for_tsc_output.js COMMAND
15
-
16
- COMMAND:
17
- run: Update lib/.gitignore file.
18
- help: Print this menu.
19
-
20
- NOTES FOR USAGE:
21
- 1. This script is tested to work on Ubuntu 18.04 LTS.
22
- `;
23
-
24
- const gitignoreHeader = `# DO NOT EDIT, GENERATED BY: scripts/update_gitignore_for_tsc_output.js
25
-
26
- # Do not include tsc generated type definitions
27
- **/*.d.ts
28
-
29
- # Do not include tsc source maps
30
- **/*.js.map
31
-
32
- # Do not include .js files from .ts files
33
- `;
34
-
35
- function main(cliCommand) {
36
- if (cliCommand === 'run') {
37
- console.log('Generating lib/.gitignore ...');
38
-
39
- // Find all .ts files in lib/
40
- const directoriesToProcess = [libDirectory];
41
- const tsFiles = [];
42
- while (directoriesToProcess.length > 0) {
43
- const directory = directoriesToProcess.pop();
44
- if (!fs.existsSync(directory)) {
45
- throw new Error("Directory doesn't exist:", directory);
46
- }
47
-
48
- const files = fs.readdirSync(directory);
49
- files.forEach((file) => {
50
- const filename = path.join(directory, file);
51
- const stat = fs.lstatSync(filename);
52
- if (stat.isDirectory()) {
53
- directoriesToProcess.push(filename);
54
- } else if (filename.endsWith('.ts') && !filename.endsWith('.d.ts')) {
55
- tsFiles.push(filename);
56
- console.log('Found .ts file:', filename);
57
- }
58
- });
59
- }
60
-
61
- // Get paths of .js files to ignore
62
- const jsFilesToIgnore = tsFiles.map((filepath) => {
63
- // Cuts off `${libDirectory}/`
64
- const relativeTsPath = filepath.slice(libDirectory.length + 1);
65
- // Swaps .ts for .js file ending
66
- const relativeJsPath =
67
- relativeTsPath.slice(0, relativeTsPath.length - 3) + '.js';
68
- // Always use POSIX-style path separators - .gitignore requires it
69
- return relativeJsPath.split(path.sep).join(path.posix.sep);
70
- });
71
- const jsFilesToIgnoreString = jsFilesToIgnore.join('\n');
72
- const libGitignorePath = path.join(libDirectory, '.gitignore');
73
- fs.writeFileSync(
74
- libGitignorePath,
75
- gitignoreHeader + jsFilesToIgnoreString + '\n'
76
- );
77
- console.log('DONE');
78
- } else if (['help', '--help', '-h', undefined].includes(cliCommand)) {
79
- console.log(helpText);
80
- } else {
81
- console.log(`Unsupported command: ${cliCommand}`);
82
- console.log("Try running with 'help' to see supported commands.");
83
- process.exit(1);
84
- }
85
- }
86
-
87
- // Main script logic
88
- const cliCommand = process.argv[2];
89
- // Start the bash app's main function
90
- main(cliCommand);
1
+ #!/usr/bin/env node
2
+
3
+ const path = require('path');
4
+ const fs = require('fs');
5
+
6
+ // Directory constants
7
+ const scriptDirectory = __dirname;
8
+ const repoDirectory = path.join(scriptDirectory, '..');
9
+ const libDirectory = path.join(repoDirectory, 'lib');
10
+
11
+ const helpText = `
12
+ Helper script to update lib/.gitignore for all .js files from .ts files.
13
+
14
+ update_gitignore_for_tsc_output.js COMMAND
15
+
16
+ COMMAND:
17
+ run: Update lib/.gitignore file.
18
+ help: Print this menu.
19
+
20
+ NOTES FOR USAGE:
21
+ 1. This script is tested to work on Ubuntu 18.04 LTS.
22
+ `;
23
+
24
+ const gitignoreHeader = `# DO NOT EDIT, GENERATED BY: scripts/update_gitignore_for_tsc_output.js
25
+
26
+ # Do not include tsc generated type definitions
27
+ **/*.d.ts
28
+
29
+ # Do not include tsc source maps
30
+ **/*.js.map
31
+
32
+ # Do not include .js files from .ts files
33
+ `;
34
+
35
+ function main(cliCommand) {
36
+ if (cliCommand === 'run') {
37
+ console.log('Generating lib/.gitignore ...');
38
+
39
+ // Find all .ts files in lib/
40
+ const directoriesToProcess = [libDirectory];
41
+ const tsFiles = [];
42
+ while (directoriesToProcess.length > 0) {
43
+ const directory = directoriesToProcess.pop();
44
+ if (!fs.existsSync(directory)) {
45
+ throw new Error("Directory doesn't exist:", directory);
46
+ }
47
+
48
+ const files = fs.readdirSync(directory);
49
+ files.forEach((file) => {
50
+ const filename = path.join(directory, file);
51
+ const stat = fs.lstatSync(filename);
52
+ if (stat.isDirectory()) {
53
+ directoriesToProcess.push(filename);
54
+ } else if (filename.endsWith('.ts') && !filename.endsWith('.d.ts')) {
55
+ tsFiles.push(filename);
56
+ console.log('Found .ts file:', filename);
57
+ }
58
+ });
59
+ }
60
+
61
+ // Get paths of .js files to ignore
62
+ const jsFilesToIgnore = tsFiles.map((filepath) => {
63
+ // Cuts off `${libDirectory}/`
64
+ const relativeTsPath = filepath.slice(libDirectory.length + 1);
65
+ // Swaps .ts for .js file ending
66
+ const relativeJsPath =
67
+ relativeTsPath.slice(0, relativeTsPath.length - 3) + '.js';
68
+ // Always use POSIX-style path separators - .gitignore requires it
69
+ return relativeJsPath.split(path.sep).join(path.posix.sep);
70
+ });
71
+ const jsFilesToIgnoreString = jsFilesToIgnore.join('\n');
72
+ const libGitignorePath = path.join(libDirectory, '.gitignore');
73
+ fs.writeFileSync(
74
+ libGitignorePath,
75
+ gitignoreHeader + jsFilesToIgnoreString + '\n'
76
+ );
77
+ console.log('DONE');
78
+ } else if (['help', '--help', '-h', undefined].includes(cliCommand)) {
79
+ console.log(helpText);
80
+ } else {
81
+ console.log(`Unsupported command: ${cliCommand}`);
82
+ console.log("Try running with 'help' to see supported commands.");
83
+ process.exit(1);
84
+ }
85
+ }
86
+
87
+ // Main script logic
88
+ const cliCommand = process.argv[2];
89
+ // Start the bash app's main function
90
+ main(cliCommand);