Merge pull request #4 from Daniihh/workflow

Make master Package Ready

Author: danii

.gitignore

@@ -1,2 +1,3 @@
-node_modules
-out/
+# Ignore generated files.
+node_modules/
+dist/

.npmignore

@@ -0,0 +1,3 @@
+# Ignore development files.
+test/
+gulpfile.js

gulpfile.js

@@ -1,8 +1,8 @@
-const [{src, dest}, fs, ts, rename, compress, merge] =
-  ["!gulp", "!fs", "typescript", "rename", "minify", "!merge-stream"]
+const [{src, dest}, fs, ts, rename, compress, merge, filter] =
+  ["!gulp", "!fs", "typescript", "rename", "minify", "!merge-stream", "filter"]
     .map(i => i.startsWith("!") ? i.substr(1) : `gulp-${i}`).map(require);
 
-const requiredFolders = ["out"];
+const requiredFolders = ["dist"];
 
 function ensureFolders() {
   requiredFolders.forEach(dir => fs.existsSync(dir) ? null : fs.mkdirSync(dir));
@@ -13,14 +13,14 @@ module.exports = {
     ensureFolders();
 
     const modSys = {"esmodule": "ESNext", "commonjs": "CommonJS"};
+    const dTsFilter = filter(["**", "!**/*.d.ts"], {"restore": true});
     const get = (mod) => ts.createProject("tsconfig.json", {"module": modSys[mod]});
-    const applyTs = (pipe, mod) => pipe.pipe(get(mod)()).pipe(rename(p => p.basename = mod + "-" + p.basename));
+    const applyTs = (pipe, mod) => pipe.pipe(get(mod)()).pipe(dTsFilter).pipe(rename(p => p.basename = mod + "-" + p.basename));
     const applyCompress = (pipe, opts) => pipe.pipe(compress(opts));
 
     let out = [src("./src/*.ts")];
     out = out.map(i => [applyTs(i, "esmodule"), applyTs(i, "commonjs")]).flat();
     out = out.map(i => [i, applyCompress(i, {"ext": {"min": "-min.js"}, "preserveComments": "some"})]).flat();
-    return merge(...out).pipe(dest("./out/"));
-    //return src("./src/*.ts").pipe(project()).pipe(dest("./out/"));
+    return merge(...out, dTsFilter.restore).pipe(dest("./dist/"));
   }
 }

package-lock.json

@@ -1,26 +1,31 @@
 {
-  "name": "daniis-typescript-utils",
+  "name": "daniis-tools",
   "version": "1.0.0",
-  "description": "Soon™ (Not a serious use of the TM emoji)",
-  "main": "index.js",
-  "scripts": {
-    "test": "mocha",
-    "start": "gulp compile"
-  },
+  "description": "A set of functions, types, better typings and extra methods to improve your coding experience.",
+  "main": "dist/commonjs-tools.js",
+  "types": "dist/tools.d.ts",
+  "author": "Daniel Conley",
+  "license": "GPL-3.0",
+  "keywords": [
+    "tools", "types", "prototype", "extension", "methods", "utility", "util"
+  ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Daniihh/daniis-typescript-utils.git"
+    "url": "https://github.com/Daniihh/daniis-typescript-utils.git"
   },
-  "author": "Daniihh",
-  "license": "ISC",
   "bugs": {
     "url": "https://github.com/Daniihh/daniis-typescript-utils/issues"
   },
   "homepage": "https://github.com/Daniihh/daniis-typescript-utils#readme",
+  "scripts": {
+    "test": "mocha",
+    "compile": "gulp compile"
+  },
   "dependencies": {},
   "devDependencies": {
     "@types/node": "^12.12.14",
     "gulp": "^4.0.2",
+    "gulp-filter": "^6.0.0",
     "gulp-minify": "^3.1.0",
     "gulp-rename": "^2.0.0",
     "gulp-typescript": "^6.0.0-alpha.1",

package.json

@@ -66,10 +66,8 @@ type PsuedoObject<T extends Primitive> =
 
 /**
  * A union of all JavaScript primitives.
- * 
- * Exclusion Reason: Exporting is not necessary at this point in time.
  */
-type Primitive = string | number | bigint | boolean | symbol;
+export type Primitive = string | number | bigint | boolean | symbol;
 
 /*
   Quick Definitions
@@ -347,7 +345,7 @@ declare global {
      * @param str String to interpolate with.
      * @param values The variables supplied.
      */
-    interpolate(values: Of<any>);
+    interpolate(values: Of<any>): string;
   }
 
   interface SymbolConstructor {

src/tools.ts

@@ -1,8 +1,9 @@
 {
   "compilerOptions": {
-    "target": "es6",
+    "target": "ES6",
     "lib": ["ESNext", "ES2017.Object", "ESNext.array", "ES2020.String"],
     "esModuleInterop": true,
-    "experimentalDecorators": true
+    "experimentalDecorators": true,
+    "declaration": true
   }
 }