Initial commit

Author: T99

.d.ts/readme.md

@@ -0,0 +1 @@
+This folder contains definition files for this project.

.gitignore

@@ -0,0 +1,4 @@
+.gitignore
+.idea/
+ts/tslint.json
+node_modules/

gulpfile.js

@@ -0,0 +1,132 @@
+/*
+ *	Created by Trevor Sears <[email protected]>.
+ *	8:48 PM -- June 16th, 2019.
+ *	Project: repo-name
+ */
+
+const gulp = require("gulp");
+const typescript = require("gulp-typescript");
+const sourcemaps = require("gulp-sourcemaps");
+const uglify = require("gulp-uglify-es").default;
+const del = require("del");
+
+const paths = {
+	
+	typescript: {
+		
+		dir: "ts/",
+		allFiles: "ts/**/*.ts",
+		tsconfig: "ts/tsconfig.json"
+		
+	},
+	
+	javascript: {
+		
+		dir: "js/",
+		allFiles: "js/**/*.js",
+		entryPoint: "js/main.js",
+		entryPointFileName: "main.js"
+		
+	},
+	
+	typedefs: {
+		
+		dir: ".d.ts/",
+		allFiles: ".d.ts/**/*.d.ts"
+		
+	}
+	
+};
+
+let typescriptProject = typescript.createProject(paths.typescript.tsconfig);
+
+// The default Gulp task.
+gulp.task("default", defaultTask);
+
+// Cleans (deletes) all generated/compiled files.
+gulp.task("clean", clean);
+
+// Builds the entire project.
+gulp.task("build", build);
+
+// Cleans and builds the entire project.
+gulp.task("rebuild", rebuild);
+
+// Watch for changes to relevant files and compile-on-change.
+gulp.task("watch", watch);
+
+function defaultTask(done) {
+
+	return rebuild(done);
+	
+}
+
+function clean(done) {
+	
+	return del([
+		paths.javascript.dir,
+		paths.typedefs.dir
+	]);
+	
+}
+
+function build(done) {
+	
+	return buildJavaScriptPipeline(done);
+	
+}
+
+function rebuild(done) {
+	
+	gulp.series(clean, build)(done);
+	
+}
+
+function buildJavaScriptPipeline(done) {
+	
+	return gulp.series(
+		compileTypeScript,
+		uglifyJavaScript
+	)(done);
+	
+}
+
+function compileTypeScript(done) {
+	
+	let proj =
+		typescriptProject.src()
+			.pipe(sourcemaps.init())
+			.pipe(typescriptProject());
+	
+	let compileJS = (done) => {
+		
+		return proj.js
+			.pipe(sourcemaps.write("."))
+			.pipe(gulp.dest(paths.javascript.dir));
+		
+	};
+	
+	let compileDTS = (done) => {
+		
+		return proj.dts
+			.pipe(gulp.dest(paths.typedefs.dir));
+		
+	};
+	
+	return gulp.parallel(compileJS, compileDTS)(done);
+	
+}
+
+function uglifyJavaScript(done) {
+
+	return gulp.src(paths.javascript.allFiles)
+		.pipe(uglify())
+		.pipe(gulp.dest(paths.javascript.dir));
+
+}
+
+function watch(done) {
+	
+	gulp.watch([paths.typescript.allFiles], buildJavaScriptPipeline);
+	
+}

init.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+# Stop tracking certain files that were pulled from the template.
+git rm --cached ./ts/tslint.json ./.gitignore
+
+# Delete the readmes that were used to track otherwise-empty dirs.
+rm ./.d.ts/readme.md ./js/readme.md ./ts/readme.md ./ts/tests/readme.md
+
+# Install the missing packages from our package.json file.
+npm install
+
+# Remind the user to update relevant package information from the template and commit the above changes.
+echo "Remember to modify the package.json, license.md, and readme.md to correct the relevant package information."
+echo "Also remember to commit the changes that this script has made."
+
+echo "All done, bye!"
+
+# Make the script remove itself.
+rm -- "$0"

jest.config.js

@@ -0,0 +1,185 @@
+// For a detailed explanation regarding each configuration property, visit:
+// https://jestjs.io/docs/en/configuration.html
+
+module.exports = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // Respect "browser" field in package.json when resolving modules
+  // browser: false,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/tmp/jest_rs",
+
+  // Automatically clear mock calls and instances between every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+  
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: null,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "ts/tests/coverage",
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: null,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: null,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: null,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: null,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "json",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: null,
+
+  // Run tests from one or more projects
+  // projects: null,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state between every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: null,
+
+  // Automatically restore mock state between every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: null,
+
+  // A list of paths to directories that Jest should use to search for files in
+  roots: [
+    "<rootDir>/js/tests"
+  ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: "node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: null,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jasmine2",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  // transform: null,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: null,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};

js/readme.md

@@ -0,0 +1 @@
+This folder contains compiled JavaScript files for this project.