@camoto/gamecode - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

cli/index.js

@@ -121,3 +121,3 @@ /*
 				});
-				throw new OperationsError('open: please use the -f option to specify the format.');
+				throw new OperationsError('open: please use the -t option to specify the format.');
 			}
@@ -210,7 +210,7 @@ handler = handlers[0];
 	open: [
-		{ name: 'format', alias: 'f' },
+		{ name: 'format', alias: 't' },
 		{ name: 'target', defaultOption: true },
 	],
 	save: [
-		{ name: 'format', alias: 'f' },
+		{ name: 'format', alias: 't' },
 		{ name: 'target', defaultOption: true },
@@ -283,4 +283,4 @@ ],
 
-  open [-f format] <file>
-    Open the local <file> as an executable, autodetecting the format unless -f
+  open [-t format] <file>
+    Open the local <file> as an executable, autodetecting the format unless -t
     is given.  Use --formats for a list of possible values.
@@ -287,0 +287,0 @@

formats/exe-cosmo1.js

@@ -25,3 +25,2 @@ /*
 
-import { RecordBuffer, RecordType } from '@camoto/record-io-buffer';
 import CodeHandler_Simple from '../interface/CodeHandler_Simple.js';
@@ -282,2 +281,2 @@
 	}
-};
+}

index.js

@@ -89,2 +89,2 @@ /*
 	return handlers;
-};
+}

package.json

 {
   "name": "@camoto/gamecode",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Modify executable files used by DOS games",
@@ -15,3 +15,3 @@ "bin": {
     "type": "git",
-    "url": "git+ssh://[e-mail]/Malvineous/gamecodejs.git"
+    "url": "git+ssh://[e-mail]/camoto-project/gamecodejs.git"
   },
@@ -28,12 +28,12 @@ "keywords": [
   "bugs": {
-    "url": "https://github.com/Malvineous/gamecodejs/issues"
+    "url": "https://github.com/camoto-project/gamecodejs/issues"
   },
-  "homepage": "https://github.com/Malvineous/gamecodejs#readme",
+  "homepage": "https://github.com/camoto-project/gamecodejs#readme",
   "dependencies": {
-    "@camoto/gamecomp": "^2.0.2",
-    "@camoto/record-io-buffer": "^3.0.0",
-    "command-line-args": "^5.1.1",
+    "@camoto/gamecomp": "^2.5.0",
+    "@camoto/record-io-buffer": "^3.1.3",
     "debug": "^4.3.1"
   },
   "devDependencies": {
+    "command-line-args": "^5.1.1",
     "eslint": "^7.17.0",
@@ -43,2 +43,10 @@ "mocha": "^8.2.1",
   },
+  "files": [
+    "bin/",
+    "cli/*.js",
+    "formats/",
+    "interface/",
+    "util/",
+    "index.js"
+  ],
   "directories": {
@@ -45,0 +53,0 @@ "test": "test"

README.md

@@ -29,7 +29,7 @@ # gamecode.js
 If you wish to use the command-line `gamecode` utility to work with game
-executables directly, you can install the library globally on your system:
+executables directly, you can install the CLI globally on your system:
 
-    npm install -g @camoto/gamecode
+    npm install -g @camoto/gamecode-cli
 
-For Arch Linux users the AUR package `gamecodejs` is also available.
+For Arch Linux users the AUR package `gamecode-cli` is also available.
 
@@ -95,7 +95,7 @@ ### Command line interface
 
-    npm install --dev
+    npm install
 
 Run the tests to make sure everything worked:
 
-    npm run -s test
+    npm test
 
@@ -106,12 +106,11 @@ You're ready to go!  To add a new file format:
     Copying an existing file that covers a similar format will help
-    considerably.  If you're not sure, `arc-grp-build.js` is a good
-    starting point as it is fairly simple.
+    considerably.
     
- 2. Edit `formats/index.js` and add a line for your new file.
+ 2. Edit `formats/index.js` and add an `import` statement for your new file.
 
 If your file format has any sort of compression or encryption, these algorithms
-should go into the [gamecompjs](https://github.com/Malvineous/gamecompjs)
+should go into the [gamecomp.js](https://github.com/Malvineous/gamecompjs)
 project instead.  This is to make it easier to reuse the algorithms, as many of
 them (particularly the compression ones) are used amongst many unrelated file
-formats.  All the gamecompjs algorithms are available to be used by any format
+formats.  All the gamecomp.js algorithms are available to be used by any format
 in this library.
@@ -122,3 +121,3 @@
     # Read a sample song and list its details, with debug messages on
-    $ DEBUG='gamecode:*' ./bin/gamecode open -f exe-myformat example.exe list
+    $ DEBUG='gamecode:*' ./bin/gamecode open -t exe-myformat example.exe list
 
@@ -125,0 +124,0 @@ # Make sure the format is identified correctly or if not why not

util/decompress.js

@@ -20,3 +20,3 @@ /*
 
-import cmp_lzexe from '@camoto/gamecomp/compress/cmp-lzexe.js';
+import { cmp_lzexe } from '@camoto/gamecomp';
 
@@ -23,0 +23,0 @@ /**

No alert changes

Improved metrics

Dependency count

3

decreased by-25%

Worsened metrics

Total package byte prevSize

41633

decreased by-2.65%

Dev dependency count

4

increased by33.33%

Number of package files

11

decreased by-15.38%

Lines of code

917

decreased by-8.3%

Number of lines in readme file

126

decreased by-0.79%

Dependency changes

• - Removedcommand-line-args@^5.1.1

• - Removedarray-back@3.1.0(transitive)

• - Removedcommand-line-args@5.2.1(transitive)

• - Removedfind-replace@3.0.0(transitive)

• - Removedlodash.camelcase@4.3.0(transitive)

• - Removedtypical@4.0.0(transitive)

• Updated@camoto/gamecomp@^2.5.0

• Updated@camoto/record-io-buffer@^3.1.3