GH-3: rename project to class-types

Author: renderorange

.github/workflows/release.yml

@@ -125,7 +125,7 @@ jobs:
                       
                       # Add version link
                       echo "" >> "$TEMP_FILE"
-                      echo "[$NEW_VERSION]: https://github.com/renderorange/types-class/releases/tag/v$NEW_VERSION" >> "$TEMP_FILE"
+                      echo "[$NEW_VERSION]: https://github.com/renderorange/class-types/releases/tag/v$NEW_VERSION" >> "$TEMP_FILE"
                       
                       mv "$TEMP_FILE" CHANGELOG.md
                   else
@@ -147,7 +147,7 @@ jobs:
                   - Compound types: isaAnyOf, isaAllOf, isaNoneOf
                   - Utilities: validate(), maybe()
 
-                  [1.0.0]: https://github.com/renderorange/types-class/releases/tag/v1.0.0
+                  [1.0.0]: https://github.com/renderorange/class-types/releases/tag/v1.0.0
                   EOF
                       sed -i "s/## \[1.0.0\]/## [$NEW_VERSION] - $DATE\n\n### Added\n- Release version $NEW_VERSION\n\n## [1.0.0]/" CHANGELOG.md
                       sed -i "s|/v1.0.0|/v$NEW_VERSION|" CHANGELOG.md

CHANGELOG.md

@@ -14,4 +14,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Compound types: isaAnyOf, isaAllOf, isaNoneOf
 - Utilities: validate(), maybe()
 
-[1.0.0]: https://github.com/renderorange/types-class/releases/tag/v1.0.0
+[1.0.0]: https://github.com/renderorange/class-types/releases/tag/v1.0.0

README.md

@@ -1,21 +1,21 @@
-# @renderorange/types-class
+# @renderorange/class-types
 
 Runtime type checking base class for JavaScript.
 
 ## Installation
 
 ```bash
-npm install @renderorange/types-class
+npm install @renderorange/class-types
 ```
 
 ## Usage
 
-Extend `TypesClass` and define methods that use the built-in type checks:
+Extend `ClassTypes` and define methods that use the built-in type checks:
 
 ```javascript
-const TypesClass = require("@renderorange/types-class");
+const ClassTypes = require("@renderorange/class-types");
 
-class User extends TypesClass {
+class User extends ClassTypes {
     constructor(name, email, age) {
         super();
         this.name = this.validate("name", name, "isaString");
@@ -32,7 +32,7 @@ const user = new User("John", "john@example.com", 25);
 The `maybe` method allows values to be null or undefined, but validates the type if a value is provided:
 
 ```javascript
-class User extends TypesClass {
+class User extends ClassTypes {
     constructor(name, email, age) {
         super();
         this.name = this.validate("name", name, "isaString");
@@ -52,7 +52,7 @@ new User("John", "john@example.com", 25, 123);  // throws TypeError
 Combinators let you combine multiple type checks:
 
 ```javascript
-class User extends TypesClass {
+class User extends ClassTypes {
     constructor(name, email, age, phone) {
         super();
         this.name = this.validate("name", name, "isaString");
@@ -86,7 +86,7 @@ class User extends TypesClass {
 You can also use combinators through `validate()` by passing the type methods array as an extra argument:
 
 ```javascript
-class User extends TypesClass {
+class User extends ClassTypes {
     constructor(name, identifier) {
         super();
         this.name = this.validate("name", name, "isaString");

package-lock.json

@@ -1,10 +1,10 @@
 {
-    "name": "@renderorange/types-class",
+    "name": "@renderorange/class-types",
     "version": "1.0.0",
     "description": "Base class for runtime type checking in JavaScript",
     "author": "Blaine Motsinger <blaine@renderorange.com>",
     "license": "MIT",
-    "main": "src/types_class.js",
+    "main": "src/class_types.js",
     "files": [
         "src/",
         "LICENSE",
@@ -22,12 +22,12 @@
     ],
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/renderorange/types-class.git"
+        "url": "git+https://github.com/renderorange/class-types.git"
     },
     "bugs": {
-        "url": "https://github.com/renderorange/types-class/issues"
+        "url": "https://github.com/renderorange/class-types/issues"
     },
-    "homepage": "https://github.com/renderorange/types-class#readme",
+    "homepage": "https://github.com/renderorange/class-types#readme",
     "publishConfig": {
         "access": "public"
     },

package.json

@@ -1,7 +1,7 @@
 const EMAIL_REGEX = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
 const URL_REGEX = /^https?:\/\/.+/;
 
-class TypesClass {
+class ClassTypes {
     #check (methodName, predicate, value) {
         if (!predicate(value)) {
             const actualType = value === null ? "null" : typeof value;
@@ -193,4 +193,4 @@ class TypesClass {
     }
 }
 
-module.exports = TypesClass;
+module.exports = ClassTypes;

src/types_class.js src/class_types.jssrc/types_class.js renamed to src/class_types.js

@@ -1,6 +1,6 @@
-const TypesClass = require("../src/types_class.js");
+const ClassTypes = require("../src/class_types.js");
 
-class TestChild extends TypesClass {
+class TestChild extends ClassTypes {
     testPositiveInt (value) {
         return this.isaPositiveInt(value);
     }
@@ -50,7 +50,7 @@ class TestChild extends TypesClass {
     }
 }
 
-describe("TypesClass", () => {
+describe("ClassTypes", () => {
     let instance;
 
     beforeEach(() => {
@@ -432,7 +432,7 @@ describe("TypesClass", () => {
         });
 
         test("can be used directly in constructor", () => {
-            class TestUser extends TypesClass {
+            class TestUser extends ClassTypes {
                 constructor (identifier) {
                     super();
                     this.identifier = this.isaAnyOf(["isaString", "isaNumber"], identifier);
@@ -470,7 +470,7 @@ describe("TypesClass", () => {
         });
 
         test("can be used with isaString for length validation pattern", () => {
-            class TestUser extends TypesClass {
+            class TestUser extends ClassTypes {
                 validatePhone (phone) {
                     return this.isaAllOf(["isaString"], phone);
                 }
@@ -573,7 +573,7 @@ describe("TypesClass", () => {
         });
 
         test("can use combinators in constructor via validate", () => {
-            class TestUser extends TypesClass {
+            class TestUser extends ClassTypes {
                 constructor (name, identifier) {
                     super();
                     this.name = this.validate("name", name, "isaString");
@@ -597,7 +597,7 @@ describe("TypesClass", () => {
         });
 
         test("can be used in class constructor patterns", () => {
-            class TestUser extends TypesClass {
+            class TestUser extends ClassTypes {
                 constructor (name, age) {
                     super();
                     this.name = this.validate("name", name, "isaString");
@@ -660,7 +660,7 @@ describe("TypesClass", () => {
         });
 
         test("can be used in class constructor for optional fields", () => {
-            class TestUser extends TypesClass {
+            class TestUser extends ClassTypes {
                 constructor (name, nickname) {
                     super();
                     this.name = this.validate("name", name, "isaString");