twenty 0.2.0 → 2.46.0

package/src/app/typecheck/README.md

@@ -0,0 +1,67 @@
+# Application typechecking
+
+The CLI typechecks applications using their own TypeScript installation.
+See the [app tooling overview](../README.md) for package ownership.
+
+The internal `typecheckSource` worker request checks the app's source and compiler
+configuration. `bundleSnapshot` runs this typecheck after bundling. A failed check
+discards that build's snapshot. Public build, typecheck, plan, apply and uninstall
+commands use this pipeline.
+
+## Compiler ownership
+
+The globally installed CLI resolves `typescript` from the app's `node_modules`
+or a workspace ancestor. It never falls back to its own parser dependency,
+`NODE_PATH` or Node's global package folders. Apps keep TypeScript in their
+development dependencies; neither apps nor the SDK depend on the CLI.
+
+Missing TypeScript returns `TYPESCRIPT_NOT_INSTALLED`. An incomplete installation,
+missing compiler API or unsupported Plug'n'Play installation returns
+`TOOLING_UNSUPPORTED`. The resolved compiler entry must belong to the app's
+TypeScript installation so checks use the project's compiler version.
+
+TypeScript is loaded only in the child worker. Its public JavaScript compiler API
+is required. The CLI uses the installed compiler's diagnostic categories and
+message formatter, so diagnostics follow the project's compiler version. The CLI
+parser used for source loading remains independent.
+
+## Compiler contract
+
+- Read the app's `tsconfig.json`, preserve its project references and force
+  `noEmit: true`. Do not write JavaScript, declarations or build information.
+- Configuration read/parse errors fail the check, including missing configs,
+  invalid options and missing extended configs. Source diagnostics use TS codes,
+  project-relative paths and one-based line and column numbers.
+- Unbuilt project references fail with TS6305, including diagnostics without a
+  source location. Build the referenced projects separately; this check does not
+  build them or silently ignore their errors.
+- Build warnings remain alongside typecheck diagnostics. Failure never holds a
+  snapshot for upload, and cleanup preserves unrelated snapshots.
+- Check cancellation before and after the synchronous compiler work. A busy
+  compiler cannot process IPC cancellation mid-call; the worker grace
+  period and forced termination remain the fallback.
+
+Different compiler versions can produce different diagnostics. Align compiler
+versions when comparing CLI results with another tool. See the
+[build requirements](../../../docs/commands.md#build-and-check-an-app) for
+configuration and project-reference troubleshooting.
+
+## Verification
+
+From `packages/twenty-cli`, after building the shared and SDK dependencies:
+
+```sh
+node ../../node_modules/vitest/vitest.mjs run --config vitest.config.ts src/app/typecheck src/app/snapshots --maxWorkers=1
+```
+
+The typecheck suite compares the SDK reference, the CLI implementation
+and the production worker with the same compiler. It also tests absent and hoisted
+compilers, global-path fallback, incomplete installations and actual TypeScript
+5.9.3 versus 5.7.3 behavior. The 5.7.3 compiler comes from the SDK's
+ts-morph dependency for this test only.
+
+Snapshot parity runs both real typecheck phases, with no compiler bypass.
+The app fixture supplies only the SDK's authoring/runtime exports. The apply
+contract exercises CLI snapshots against a local HTTP fixture.
+For the fresh CLI template, parity compares successful builds with the test
+setup included and Vitest configuration files excluded.

package/.npmignore

@@ -1,2 +0,0 @@
-node_modules/
-todo.txt

package/bin/twenty

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-require('../index').cli();

package/index.js

@@ -1,118 +0,0 @@
-var dns = require('dns');
-var request = require('request');
-
-var ipRegexStr = '(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.' +
-                 '(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.' +
-                 '(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.' +
-                 '(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)';
-var ipRegex = new RegExp(ipRegexStr);
-
-var toRad = function(num) {
-    return num * (Math.PI / 180);
-};
-
-var getIpInfo = function(server, callback) {
-    var ipinfo = function(p, cb) {
-        request('http://ipinfo.io/' + p, function(err, response, body) {
-            var json;
-            try {
-                json = JSON.parse(body);
-            } catch(error) {
-                return cb(error, null);
-            }
-            cb(err, json);
-        });
-    };
-
-    if (!server) {
-        return ipinfo('json', callback);
-    } else if (!server.match(ipRegex)) {
-        return dns.lookup(server, function(err, data) {
-            ipinfo(data, callback);
-        });
-    } else {
-        return ipinfo(server, callback);
-    }
-};
-
-var ipDistance = function(lat1, lon1, lat2, lon2) {
-    // Earth radius in km
-    var r = 6371;
-
-    var dLat = toRad(lat2 - lat1);
-    var dLon = toRad(lon2 - lon1);
-    lat1 = toRad(lat1);
-    lat2 = toRad(lat2);
-
-    var a = Math.sin(dLat / 2.0) * Math.sin(dLat / 2.0) + 
-        Math.sin(dLon / 2.0) * Math.sin(dLon / 2.0) * Math.cos(lat1) * Math.cos(lat2);
-    var c = 2.0 * Math.atan2(Math.sqrt(a), Math.sqrt(1.0 - a));
-    return r * c;
-};
-
-var findDistance = function(ip1, ip2, callback) {
-    var lat1, lon1, lat2, lon2;
-
-    getIpInfo(ip1, function(err, data1) {
-        var coords1 = data1.loc.split(',');
-        lat1 = Number(coords1[0]);
-        lon1 = Number(coords1[1]);
-        getIpInfo(ip2, function(err, data2) {
-            var coords2 = data2.loc.split(',');
-            lat2 = Number(coords2[0]);
-            lon2 = Number(coords2[1]);
-
-            var dist = ipDistance(lat1, lon1, lat2, lon2);
-            callback(null, dist);
-        });
-    });
-};
-
-var cli = function() {
-    var yargs = require('yargs')
-        .usage('Usage: $0 [command] [options]')
-        .command('distance <loc1> [loc2]', 'Compute the approx. distance between IPs/URLs')
-        .option('json', {
-            alias: 'j',
-            describe: 'Return data as json',
-        })
-        .example('$0', 'Get location info for your IP address')
-        .example('$0 -j', 'Get location info for your IP as json')
-        .example('$0 distance 8.8.8.8', 'Get distance from your IP to given IP')
-        .example('$0 distance stackabuse.com google.com', 'Get the distance between two given URLs')
-        .help('help')
-        .alias('h', 'help')
-        .epilog('Copyright 2016 Scott Robinson');
-
-    var argv = yargs.argv;
-
-    if (argv.loc1) {
-        findDistance(argv.loc1, argv.loc2, function(err, distance) {
-            console.log(String(distance.toFixed(2)) + ' km');
-        });
-    } else if (argv.json) {
-        getIpInfo(argv._[0], function(err, data) {
-            console.log(JSON.stringify(data, null, 4));
-        });
-    } else {
-        getIpInfo(argv._[0], function(err, data) {
-            if (err) {
-                console.log('Error:', err.message);
-                return;
-            }
-
-            console.log('IP:', data.ip);
-            console.log('Hostname:', data.hostname || '-');
-            console.log('City:', data.city || '-');
-            console.log('Region:', data.region || '-');
-            console.log('Postal:', data.postal || '-');
-            console.log('Country:', data.country || '-');
-            console.log('Coordinates:', data.loc || '-');
-            console.log('ISP:', data.org || '-');
-        });
-    }
-};
-
-exports.info = getIpInfo;
-exports.distance = findDistance;
-exports.cli = cli;