Merge pull request #49 from ndaidong/v6.x.x

v6.x.x

Author: ndaidong

README.md

@@ -18,6 +18,9 @@ To read & normalize RSS/ATOM/JSON feed data.
 ```js
 import { read } from 'feed-reader'
 
+// with CommonJS environments
+// const { read } = require('./dist/cjs/feed-reader.js')
+
 const url = 'https://news.google.com/rss'
 
 read(url).then((feed) => {

build.js

@@ -0,0 +1,77 @@
+/**
+ * build.js
+ * @ndaidong
+ **/
+
+import { readFileSync, writeFileSync, rmSync, mkdirSync } from 'fs'
+
+import { buildSync } from 'esbuild'
+
+const pkg = JSON.parse(readFileSync('./package.json', { encoding: 'utf-8' }))
+
+rmSync('dist', {
+  force: true,
+  recursive: true
+})
+mkdirSync('dist')
+
+const buildTime = (new Date()).toISOString()
+const comment = [
+  `// ${pkg.name}@${pkg.version}, by ${pkg.author}`,
+  `built with esbuild at ${buildTime}`,
+  `published under ${pkg.license} license`
+].join(' - ')
+
+/**
+ * @type {import('esbuild').BuildOptions}
+ * */
+const baseOpt = {
+  entryPoints: ['src/main.js'],
+  bundle: true,
+  charset: 'utf8',
+  target: ['es2020', 'node14'],
+  minify: true,
+  write: true,
+  sourcemap: 'external',
+  external: ['canvas']
+}
+
+/**
+ * @type {import('esbuild').BuildOptions}
+ */
+const cjsVersion = {
+  ...baseOpt,
+  platform: 'node',
+  format: 'cjs',
+  mainFields: ['main'],
+  outfile: `dist/cjs/${pkg.name}.js`,
+  banner: {
+    js: comment
+  }
+}
+buildSync(cjsVersion)
+
+const cjspkg = {
+  name: pkg.name + '-cjs',
+  version: pkg.version,
+  main: `./${pkg.name}.js`
+}
+writeFileSync(
+  'dist/cjs/package.json',
+  JSON.stringify(cjspkg, null, '  '),
+  'utf8'
+)
+
+/**
+ * @type {import('esbuild').BuildOptions}
+ */
+const browserVersion = {
+  ...baseOpt,
+  platform: 'browser',
+  format: 'esm',
+  outfile: `dist/${pkg.name}.browser.js`,
+  banner: {
+    js: comment
+  }
+}
+buildSync(browserVersion)

build.test.js

@@ -0,0 +1,30 @@
+// release.test
+
+/* eslint-env jest */
+
+import {
+  existsSync,
+  readFileSync
+} from 'fs'
+
+const pkg = JSON.parse(readFileSync('./package.json'))
+
+const cjsFile = `./dist/cjs/${pkg.name}.js`
+const cjsPkg = JSON.parse(readFileSync('./dist/cjs/package.json'))
+
+describe('Validate commonjs version output', () => {
+  test(`Check if ${cjsFile} created`, () => {
+    expect(existsSync(cjsFile)).toBeTruthy()
+  })
+  test('Check if cjs package info updated', () => {
+    expect(cjsPkg.name).toEqual(`${pkg.name}-cjs`)
+    expect(cjsPkg.version).toEqual(pkg.version)
+  })
+  const constent = readFileSync(cjsFile, 'utf8')
+  const lines = constent.split('\n')
+  test('Check if file meta contains package info', () => {
+    expect(lines[0].includes(`${pkg.name}@${pkg.version}`)).toBeTruthy()
+    expect(lines[0].includes(pkg.author)).toBeTruthy()
+    expect(lines[0].includes(pkg.license)).toBeTruthy()
+  })
+})

dist/cjs/feed-reader.js

@@ -0,0 +1,5 @@
+{
+  "name": "feed-reader-cjs",
+  "version": "6.0.1",
+  "main": "./feed-reader.js"
+}

dist/cjs/feed-reader.js.map

@@ -0,0 +1,24 @@
+// eval.cjs
+
+// to quickly test with a single url or file
+
+const { read } = require('./dist/cjs/feed-reader.js')
+
+const extractFromUrl = async (url) => {
+  try {
+    const feed = await read(url)
+    console.log(feed)
+  } catch (err) {
+    console.trace(err)
+  }
+}
+
+const init = (argv) => {
+  if (argv.length === 3) {
+    const input = argv[2]
+    return extractFromUrl(input)
+  }
+  return 'Nothing to do!'
+}
+
+init(process.argv)

dist/cjs/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "6.0.0",
+  "version": "6.0.1",
   "name": "feed-reader",
   "description": "To read and normalize RSS/ATOM/JSON feed data",
   "homepage": "https://www.npmjs.com/package/feed-reader",
@@ -17,8 +17,10 @@
   "scripts": {
     "lint": "standard .",
     "pretest": "npm run lint",
-    "test": "NODE_ENV=test NODE_OPTIONS=--experimental-vm-modules jest --verbose --coverage=true",
+    "test": "NODE_ENV=test NODE_OPTIONS=--experimental-vm-modules jest --coverage=true",
+    "build": "node build",
     "eval": "node eval",
+    "eval:cjs": "node eval.cjs",
     "reset": "node reset"
   },
   "dependencies": {
@@ -28,6 +30,7 @@
     "html-entities": "^2.3.3"
   },
   "devDependencies": {
+    "esbuild": "^0.15.2",
     "jest": "^28.1.3",
     "nock": "^13.2.9"
   },