@k03mad/ip2geo 2.3.1 → 3.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Kirill Molchanov
+Copyright (c) Kirill Molchanov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -5,8 +5,6 @@
 
 ## Global
 
-Cache directory = `os.tmpDir() / .ip2geo`
-
 ```bash
 npm i @k03mad/ip2geo -g
 
@@ -30,8 +28,7 @@ ip2geo 1.1.1.1 --json
 ## API
 
 ```bash
-npm i @k03mad/ip2geo --save-exact
-echo .geoip >> .gitignore
+npm i @k03mad/ip2geo
 ```
 
 ```js
@@ -39,10 +36,7 @@ import {ip2geo} from '@k03mad/ip2geo';
 
 const info = await ip2geo('1.1.1.1', {
     // defaults
-
-    // current app root
-    cacheDir: '.geoip',
-    // will be prefixed with the first IP octet
+    cacheDir: path.join(os.tmpdir(), '.ip2geo'),
     cacheFileName: 'ips.log',
     cacheFileSeparator: ';;',
     cacheFileNewline: '\n',

package/app/cli.js

@@ -1,10 +1,8 @@
 #!/usr/bin/env node
 
-import os from 'node:os';
-import path from 'node:path';
+import {log, logErrorExit} from '@k03mad/simple-log';
 
 import {codeText, errorText, nameText} from './helpers/colors.js';
-import {log, throwError} from './helpers/logging.js';
 
 import {ip2geo} from './index.js';
 
@@ -16,7 +14,7 @@ if (args.length === 0) {
     const prefix = codeText('$');
     const name = nameText('ip2geo');
 
-    throwError([
+    logErrorExit([
         errorText('IP(s) should be passed as args'),
         '',
         `${prefix} ${name} 1.1.1.1`,
@@ -32,9 +30,7 @@ if (args.includes(jsonParam)) {
 }
 
 await Promise.all(args.map(async arg => {
-    const output = await ip2geo(arg, {
-        cacheDir: path.join(os.tmpdir(), '.ip2geo'),
-    });
+    const output = await ip2geo(arg);
 
     if (json) {
         return log(JSON.stringify(output));

package/app/lib/ip2geo.js

@@ -1,4 +1,5 @@
 import fs from 'node:fs/promises';
+import os from 'node:os';
 import path from 'node:path';
 
 import {request} from '@k03mad/request';
@@ -21,7 +22,7 @@ const debug = _debug('mad:geoip');
 
 const API = 'https://ipwho.is/';
 
-const DEFAULT_CACHE_FILE_DIR = '.geoip';
+const DEFAULT_CACHE_FILE_DIR = path.join(os.tmpdir(), '.ip2geo');
 const DEFAULT_CACHE_FILE_NAME = 'ips.log';
 const DEFAULT_CACHE_FILE_SEPARATOR = ';;';
 const DEFAULT_CACHE_FILE_NEWLINE = '\n';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@k03mad/ip2geo",
-  "version": "2.3.1",
+  "version": "3.0.0",
   "description": "GeoIP library",
   "maintainers": [
     "Kirill Molchanov <k03.mad@gmail.com"
@@ -20,11 +20,12 @@
   },
   "dependencies": {
     "@k03mad/request": "5.4.1",
+    "@k03mad/simple-log": "2.0.0",
     "chalk": "5.3.0",
     "debug": "4.3.4"
   },
   "devDependencies": {
-    "@k03mad/eslint-config": "19.2.0",
+    "@k03mad/eslint-config": "19.3.0",
     "eslint": "8.56.0",
     "husky": "8.0.3",
     "mocha": "10.2.0"

package/tests/helpers/path.js

@@ -10,4 +10,4 @@ export const getCurrentFilename = file => path.basename(file, '.js');
  * @param {string} file
  * @returns {string}
  */
-export const getTestFolder = file => path.join('.geoipCustom', file);
+export const getTestFolder = file => path.join('.geoip', file);

package/tests/opts-default.js

@@ -1,4 +1,6 @@
 import assert from 'node:assert/strict';
+import os from 'node:os';
+import path from 'node:path';
 
 import {describe, it} from 'mocha';
 
@@ -7,7 +9,7 @@ import {ip2geo} from '../app/index.js';
 import {checkCacheFile, removeCacheFolder} from './shared/fs.js';
 
 describe('opts-default', () => {
-    const CACHE_FILE_DIR = '.geoip';
+    const CACHE_FILE_DIR = path.join(os.tmpdir(), '.ip2geo');
     const CACHE_FILE_NAME = 'ips.log';
     const CACHE_FILE_SEPARATOR = ';;';
     const CACHE_FILE_NEWLINE = '\n';

package/app/helpers/array.js

@@ -1,5 +0,0 @@
-/**
- * @param {any|any[]} elem
- * @returns {any[]}
- */
-export const convertToArray = elem => Array.isArray(elem) ? elem : [elem];

package/app/helpers/logging.js

@@ -1,26 +0,0 @@
-/* eslint-disable no-console */
-
-import {convertToArray} from './array.js';
-
-/**
- * @param {any|any[]} msg
- * @returns {void}
- */
-export const log = msg => convertToArray(msg)
-    .forEach(elem => console.log(elem));
-
-/**
- * @param {any|any[]} msg
- * @returns {void}
- */
-export const logError = msg => convertToArray(msg)
-    .forEach(elem => console.error(elem));
-
-/**
- * @param {any|any[]} msg
- * @returns {void}
- */
-export const throwError = msg => {
-    logError(msg);
-    process.exit(1);
-};