renaming from 'Typl' to 'TypL' to emphasize the linter part

getify · getify · commit c7bd0700273a · 2019-04-22T08:27:55.000-05:00
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# Typl
+# TypL
 
-Coming Soon
+The JavaScript Type Linter. Coming Soon.
 
 ## License
 
diff --git a/lib/cli.js b/lib/cli.js
@@ -3,7 +3,7 @@
 var path = require("path");
 var fs = require("fs");
 
-var Typl = require(path.join(__dirname,".."));
+var TL = require(path.join(__dirname,".."));
 
 var args = require("minimist")(process.argv.slice(2),{
 	boolean: ["help",],
@@ -16,7 +16,7 @@ if (args.help) {
 }
 else if (args.file) {
 	let contents = fs.readFileSync(path.resolve(args.file),"utf-8");
-	Typl.Checker.check(contents);
+	TL.Checker.check(contents);
 }
 else {
 	reportError("Incorrect usage.",/*showHelp=*/true);
@@ -37,7 +37,7 @@ function reportError(err,showHelp = false) {
 }
 
 function outputHelp() {
-	console.log("Typl Usage:");
+	console.log("TypL Usage:");
 	console.log("  typl --file={FILENAME}");
 	console.log("");
 	console.log("--help                                    show this help");
diff --git a/lib/copyright-header.txt b/lib/copyright-header.txt
@@ -1,4 +1,4 @@
-/*! typl.js
+/*! TypL
 	v${version} (c) ${year} Kyle Simpson
 	MIT License: http://getify.mit-license.org
 */
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "typl",
 	"version": "0.3.0",
-	"description": "Optional type annotations and type-check linting",
+	"description": "Optional type annotations and type-check linting in standard JS",
 	"main": "./lib/index.js",
 	"scripts": {
 		"test": "node scripts/node-tests.js",
@@ -27,15 +27,15 @@
 		"qunit": "~2.9.1",
 		"terser": "~3.14.1"
 	},
-	"repository": "getify/Typl",
+	"repository": "getify/TypL",
 	"keywords": [
 		"types"
 	],
 	"bugs": {
-		"url": "https://github.com/getify/Typl/issues",
+		"url": "https://github.com/getify/TypL/issues",
 		"email": "getify@gmail.com"
 	},
-	"homepage": "https://github.com/getify/Typl",
+	"homepage": "https://github.com/getify/TypL",
 	"author": "Kyle Simpson <getify@gmail.com>",
 	"license": "MIT"
 }
diff --git a/scripts/build-core.js b/scripts/build-core.js
@@ -22,21 +22,21 @@ var fs = require("fs"),
 
 // ***************************
 
-console.log("*** Building Typl ***");
+console.log("*** Building TypL ***");
 
 // read version number from package.json
 var packageJSON = JSON.parse(
 	fs.readFileSync(
 		path.join(ROOT_DIR,"package.json"),
-		{ encoding: "utf8" }
+		{ encoding: "utf8", }
 	)
 );
 var version = packageJSON.version;
 
 // read copyright-header text, render with version and year
 var copyrightHeader = fs.readFileSync(
 	path.join(SRC_DIR,"copyright-header.txt"),
-	{ encoding: "utf8" }
+	{ encoding: "utf8", }
 ).replace(/`/g,"");
 copyrightHeader = Function("version","year",`return \`${copyrightHeader}\`;`)( version, year );
 
@@ -49,26 +49,26 @@ try {
 }
 catch (err) { }
 
-for (let [idx,SRC] of LIB_SRC.entries()) {
+for (let [idx,SRC,] of LIB_SRC.entries()) {
 	let DIST = LIB_DIST[idx];
 
 	console.log(`Building: ${DIST}`);
 
 	try {
 		let result = "";
 
-		result += fs.readFileSync(SRC,{ encoding: "utf8" });
+		result += fs.readFileSync(SRC,{ encoding: "utf8", });
 
 		result = ugly.minify(result,{
 			mangle: {
-				keep_fnames: true
+				keep_fnames: true,
 			},
 			compress: {
-				keep_fnames: true
+				keep_fnames: true,
 			},
 			output: {
-				comments: /^!/
-			}
+				comments: /^!/,
+			},
 		});
 
 		// was compression successful?
@@ -81,7 +81,7 @@ for (let [idx,SRC] of LIB_SRC.entries()) {
 		result = `${copyrightHeader}${result.code}`;
 
 		// write dist
-		fs.writeFileSync( DIST, result, { encoding: "utf8" } );
+		fs.writeFileSync( DIST, result, { encoding: "utf8", } );
 	}
 	catch (err) {
 		console.error(err);
diff --git a/tests/index.html b/tests/index.html
@@ -2,7 +2,7 @@
 <html>
 <head>
 <meta charset="utf-8" />
-<title>Typl-Runtime Test Suite</title>
+<title>TypL: Runtime Test Suite</title>
 <link rel="stylesheet" href="https://code.jquery.com/qunit/qunit-2.9.1.css">
 </head>
 <body>
diff --git a/tests/qunit.config.js b/tests/qunit.config.js
@@ -13,11 +13,11 @@ function begin(details){
 	printEnvNotification();
 
 	if (details.totalTests > 0) {
-		console.log(`Typl Test Suite (${details.totalTests})`);
+		console.log(`TypL Test Suite (${details.totalTests})`);
 		console.log("");
 	}
 	else {
-		console.log(`Typl Test Suite: empty!`);
+		console.log("TypL Test Suite: empty!");
 		process.exit(1);
 	}
 }
@@ -26,7 +26,7 @@ function testLog(details) {
 	var testId = details.testId;
 
 	testLogEntries[testId] = testLogEntries[testId] || {};
-	testLogEntries[testId][details.message] = {...details};
+	testLogEntries[testId][details.message] = { ...details, };
 }
 
 function testDone(results){
@@ -36,7 +36,7 @@ function testDone(results){
 		console.log(`Failed: '${results.name}' (${results.failed}/${results.total})`);
 		for (let i = 0; i < results.assertions.length; i++) {
 			if (results.assertions[i].result === false) {
-				let { message, expected, actual, source } = testLogEntries[testId][results.assertions[i].message];
+				let { message, expected, actual, source, } = testLogEntries[testId][results.assertions[i].message];
 				console.log(`  ${message}`);
 				// is there a JS exception stack trace included?
 				if (source && /^\w*Error: .+/.test(source)) {
diff --git a/tests/tests.checker.js b/tests/tests.checker.js
@@ -1,11 +1,11 @@
 "use strict";
 
 var path = require("path");
-var Typl = require(path.join(__dirname,"..","lib"));
+var TL = require(path.join(__dirname,"..","lib"));
 
 QUnit.test( "Checker: API", function test(assert){
 	assert.expect( 1 );
-	assert.ok( _isFunction( Typl.Checker.check ), "check(..)" );
+	assert.ok( _isFunction( TL.Checker.check ), "check(..)" );
 } );
 
 QUnit.test( "Checker: #6 number sub-types", function test(assert){
@@ -22,7 +22,7 @@ QUnit.test( "Checker: #6 number sub-types", function test(assert){
 		c = b;					// error: can't assign number to finite
 	`;
 
-	let { outputMessages, } = Typl.Checker.check(code,{ verbose: false, });
+	let { outputMessages, } = TL.Checker.check(code,{ verbose: false, });
 	let errors = outputMessages.filter(function isError(msg){ return msg.type == "error"; });
 	assert.equal(outputMessages.length,6,"total output length");
 	assert.equal(errors.length,2,"num errors");
@@ -49,7 +49,7 @@ QUnit.test( "Checker: #7 enforce bool type check in conditionals", function test
 	do{} while(foo())									// error
 	let b = foo() ? 1 : 0;						// error`
 
-	let {outputMessages} = Typl.Checker.check(code, {verbose:false});
+	let {outputMessages} = TL.Checker.check(code, {verbose:false});
 	let errors = outputMessages.filter(m => m.type == "error")
 	assert.equal(outputMessages.length, 18, 'total output length');
 	assert.equal(errors.length, 6, 'num errors');
@@ -62,7 +62,7 @@ QUnit.test( "Checker: #8 any", function test(assert){
 	a = 1;														// also OK because a is still type any
 	var b = a + 2;										// error: mixed operand types: any and number`
 
-	let {outputMessages} = Typl.Checker.check(code, {verbose:false});
+	let {outputMessages} = TL.Checker.check(code, {verbose:false});
 	let errors = outputMessages.filter(m => m.type == "error")
 	assert.equal(outputMessages.length, 16, 'total output length');
 	assert.equal(errors.length, 1, 'num errors');
@@ -82,7 +82,7 @@ QUnit.test( "Checker: #9 undef", function test(assert){
 	var d = undef\`\`;
 	d = 4;														// error, d is already tagged-type of undef`
 
-	let {outputMessages} = Typl.Checker.check(code, {verbose:false});
+	let {outputMessages} = TL.Checker.check(code, {verbose:false});
 	let errors = outputMessages.filter(m => m.type == "error")
 	assert.equal(outputMessages.length, 24, 'total output length');
 	assert.equal(errors.length, 2, 'num errors');
@@ -99,7 +99,7 @@ QUnit.test( "Checker: #17 Narrower number type inference", function test(assert)
 	y = NaN														// error, expected finite, got number
 	z = "a"														// error, expected number, found string`
 
-	let {outputMessages} = Typl.Checker.check(code, {verbose:false});
+	let {outputMessages} = TL.Checker.check(code, {verbose:false});
 	let errors = outputMessages.filter(m => m.type == "error")
 	assert.equal(outputMessages.length, 29, 'total output length');
 	assert.equal(errors.length, 3, 'num errors');
@@ -111,7 +111,7 @@ QUnit.test( "Checker: #33 Treat IIFE as a validated call-expression", function t
 		return String(x);
 	})(true);`
 
-	let {outputMessages} = Typl.Checker.check(code, {verbose:false});
+	let {outputMessages} = TL.Checker.check(code, {verbose:false});
 	let errors = outputMessages.filter(m => m.type == "error")
 	assert.equal(outputMessages.length, 32, 'total output length');
 	assert.equal(errors.length, 1, 'num errors');
@@ -125,7 +125,7 @@ QUnit.test( "Checker: #34 check tagged-type simple literals", function test(asse
 	bool\`true\`												// OK
 	bool\`ok\`													// error`
 
-	let {outputMessages} = Typl.Checker.check(code, {verbose:false});
+	let {outputMessages} = TL.Checker.check(code, {verbose:false});
 	let errors = outputMessages.filter(m => m.type == "error")
 	assert.equal(outputMessages.length, 34, 'total output length');
 	assert.equal(errors.length, 2, 'num errors');

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/*! typl.js`
	`1`	`+/*! TypL`
`2`	`2`	`v${version} (c) ${year} Kyle Simpson`
`3`	`3`	`MIT License: http://getify.mit-license.org`
`4`	`4`	`*/`