Merge pull request #10 from ksoichiro/fix-config-for-ts-and-cjs

Keep previous usage, fix package config, and add tests to confirm examples work

examples/cjs/example.test.js

@@ -0,0 +1,13 @@
+beforeAll(() => {
+  process.chdir('examples/cjs')
+})
+
+afterAll(() => {
+  process.chdir('../..')
+})
+
+test('example works', () => {
+  console.log = jest.fn()
+  require('./example.js')
+  expect(console.log).toHaveBeenCalledWith(`<p><img src="img.png" alt="" width="640" height="480"></p>`)
+})

examples/cjs/package.json

@@ -7,5 +7,8 @@
     "remark-rehype": "^8.1.0",
     "to-vfile": "^6.1.0",
     "unified": "^9.2.2"
+  },
+  "scripts": {
+    "test": "jest"
   }
 }

examples/esm/example.test.js

@@ -0,0 +1,15 @@
+import {jest} from '@jest/globals'
+
+beforeAll(() => {
+  process.chdir('examples/cjs')
+})
+
+afterAll(() => {
+  process.chdir('../..')
+})
+
+test('example works', async () => {
+  console.log = jest.fn()
+  await import('./example.js')
+  expect(console.log).toHaveBeenCalledWith(`<p><img src="img.png" alt="" width="640" height="480"></p>`)
+})

examples/esm/package.json

@@ -3,5 +3,8 @@
   "type": "module",
   "devDependencies": {
     "rehype-img-size": "file:../.."
+  },
+  "scripts": {
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest"
   }
 }

examples/ts/.gitignore

@@ -0,0 +1,2 @@
+/node_modules/
+/example.js

examples/ts/example.test.js

@@ -0,0 +1,15 @@
+import {jest} from '@jest/globals'
+
+beforeAll(() => {
+  process.chdir('examples/cjs')
+})
+
+afterAll(() => {
+  process.chdir('../..')
+})
+
+test('example works', async () => {
+  console.log = jest.fn()
+  await import('./example.js')
+  expect(console.log).toHaveBeenCalledWith(`<p><img src="img.png" alt="" width="640" height="480"></p>`)
+})

examples/ts/example.ts

@@ -0,0 +1,17 @@
+import {unified} from 'unified'
+import parse from 'remark-parse'
+import remark2rehype from 'remark-rehype'
+import stringify from 'rehype-stringify'
+import * as vfile from 'to-vfile'
+import rehypeImgSize from 'rehype-img-size'
+
+unified()
+  .use(parse)
+  .use(remark2rehype)
+  .use(rehypeImgSize)
+  .use(stringify)
+  .process(vfile.readSync('index.md'), function(err, file) {
+    if (err) throw err
+    if (!file) return
+    console.log(file.value)
+  })

examples/ts/index.md

@@ -0,0 +1 @@
+![](img.png)

examples/ts/package.json

@@ -0,0 +1,13 @@
+{
+  "private": true,
+  "type": "module",
+  "devDependencies": {
+    "@types/node": "^17.0.10",
+    "rehype-img-size": "file:../..",
+    "typescript": "^4.5.5"
+  },
+  "scripts": {
+    "build": "tsc -p .",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest"
+  }
+}

examples/ts/readme.md

@@ -0,0 +1,9 @@
+## Example of usage as TypeScript
+
+To try example, run following:
+
+```
+npm install
+npm run build
+node example.js
+```

examples/ts/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "target": "es2016",
+    "module": "es2015",
+    "skipLibCheck": true,
+    "moduleResolution": "node"
+  }
+}

index.d.ts

@@ -10,5 +10,3 @@ import type {Plugin} from 'unified'
 declare const rehypeImgSize: Plugin<[Options] | [], Root, string>
 export default rehypeImgSize
 export type {Options}
-
-export function getImageSize(src: string, dir?: string): ISize;

index.js

@@ -13,7 +13,7 @@ export default setImageSize
  */
 const absolutePathRegex = /^(?:[a-z]+:)?\/\//;
 
-export function getImageSize(src, dir) {
+function getImageSize(src, dir) {
   if (absolutePathRegex.exec(src)) {
     return
   }

index.test.js

@@ -5,7 +5,13 @@ import stringify from 'rehype-stringify'
 import * as vfile from 'to-vfile'
 import rehypeImgSize from './index'
 
-process.chdir('fixtures')
+beforeAll(() => {
+  process.chdir('fixtures')
+})
+
+afterAll(() => {
+  process.chdir('..')
+})
 
 test('images in the same directory', (done) => {
   unified()

package.json

@@ -29,6 +29,7 @@
     "types": "./index.d.ts",
     "files": [
         "index.js",
+        "index.d.ts",
         "cjs/index.cjs"
     ],
     "devDependencies": {
@@ -48,10 +49,19 @@
         "unist-util-visit": "^4.1.0"
     },
     "scripts": {
+        "postinstall": "(cd examples/cjs && npm i); (cd examples/esm && npm i); (cd examples/ts && npm i)",
+        "pretest": "(npm run build) && (cd examples/cjs && npm run build --if-present); (cd examples/esm && npm run build --if-present); (cd examples/ts && npm run build --if-present)",
         "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage",
-        "cjs": "rollup --config --file cjs/index.cjs"
+        "build": "rollup --config --file cjs/index.cjs"
     },
     "jest": {
-        "transform": {}
+        "collectCoverageFrom": [
+            "*.js"
+        ],
+        "transform": {},
+        "testPathIgnorePatterns": [
+            "<rootDir>/node_modules/",
+            "<rootDir>/cjs"
+        ]
     }
 }