@localnerve/get-attribute 1.0.0 → 1.2.0

package/eslint.config.js

@@ -7,7 +7,8 @@ const ignores = {
   ignores: [
     'bin/**',
     'node_modules/**',
-    'tmp/**'
+    'tmp/**',
+    'coverage/**'
   ]
 };
 

package/lib/cli.js

@@ -2,13 +2,22 @@
  * Get the command line args.
  * 
  * Args are url, selector, attribute, and [useprop].
+ * 
+ * Copyright (c) 2024, Alex Grant <alex@localNerve.com> (https://www.localnerve.com)
+ * Licensed under the MIT license.
  */
 const yargs = require('yargs/yargs');
 const { hideBin } = require('yargs/helpers');
+const debug = require('debug')('cli');
 
 function getCommandLineArgs (argv) {
+  debug('process argv', argv);
+
   const args = yargs(hideBin(argv)).argv;
   const prerequisite = args.url && args.selector && args.attribute;
+
+  debug('parsed args', args);
+
   if (!prerequisite) {
     return null;
   }

package/lib/get-attribute.js

@@ -1,23 +1,43 @@
 /**
  * Get an attribute from a web page given url, selector, and attributeName.
+ * 
+ * Copyright (c) 2024, Alex Grant <alex@localNerve.com> (https://www.localnerve.com)
+ * Licensed under the MIT license.
  */
 const {default: puppeteer, TimeoutError} = require('puppeteer');
+const debug = require('debug')('get-attribute');
 
 async function getAttribute (url, selector, attribute, {
   useProp = false,
   timeout = 10000
 } = {}) {
+  debug('args', 
+    `url=${url}`,
+    `selector=${selector}`, 
+    `attribute=${attribute}`, 
+    `useProp=${useProp}`,
+    `timeout=${timeout}`
+  );
+
   const browser = await puppeteer.launch();
   let attributeValue = null;
 
+  debug('launched successfully');
+
   try {
     const page = await browser.newPage();
     await page.goto(url, {
       timeout
     });
+
+    debug('navigated to url successfully');
+
     const sel = await page.waitForSelector(selector, {
       timeout
     });
+
+    debug('waited for selector successfully');
+
     /* istanbul ignore next */
     attributeValue = await sel?.evaluate((el, attrName, useProp) => {
       if (useProp) {
@@ -25,10 +45,14 @@ async function getAttribute (url, selector, attribute, {
       }
       return el.getAttribute(attrName);
     }, attribute, useProp);
+
+    debug('got attribute value', attributeValue);
+
   } catch (e) {
     if (!(e instanceof TimeoutError)) {
       throw e;
     }
+    debug('received TimeoutError', e.message);
   } finally {
     await browser.close();
   }

package/lib/index.js

@@ -2,6 +2,9 @@
  * Scrape a webpage for an attribute, write to standard out.
  * 
  * get-attribute --url=<url> --selector=<selector> --attribute=<attribute-name> [--useprop=false] [--timeout=10000]
+ * 
+ * Copyright (c) 2024, Alex Grant <alex@localNerve.com> (https://www.localnerve.com)
+ * Licensed under the MIT license.
  */
 const getArgs = require('./cli');
 const getAttr = require('./get-attribute');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@localnerve/get-attribute",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "Get an attribute from a webpage, echo to stdout",
   "main": "lib/index.js",
   "scripts": {
@@ -27,11 +27,12 @@
   },
   "homepage": "https://github.com/localnerve/get-attribute#readme",
   "dependencies": {
-    "puppeteer": "^22.6.5",
-    "yargs": "^17.7.2"
+    "puppeteer": "^22.7.0",
+    "yargs": "^17.7.2",
+    "debug": "^4.3.4"
   },
   "devDependencies": {
-    "eslint": "^9.1.0",
+    "eslint": "^9.1.1",
     "@eslint/js": "^9.1.1",
     "eslint-plugin-jest": "^28.2.0",
     "express": "^4.19.2",