merge extractus main

.github/workflows/ci-test.yml

@@ -8,40 +8,33 @@ on: [push, pull_request]
 jobs:
   test:
 
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node_version: [14.x, 15.x, 16.x, 17.x, 18.x]
+        node_version: [20.x, 22.x, 24.x]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
     - name: setup Node.js v${{ matrix.node_version }}
-      uses: actions/setup-node@v2
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node_version }}
 
     - name: run npm scripts
+      env:
+        PROXY_SERVER: ${{ secrets.PROXY_SERVER }}
       run: |
-        npm i -g standard
         npm install
         npm run lint
         npm run build --if-present
         npm run test
 
-    - name: sync to coveralls
-      uses: coverallsapp/[email protected]
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
-
     - name: cache node modules
-      uses: actions/cache@v2
+      uses: actions/cache@v4
       with:
         path: ~/.npm
         key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
         restore-keys: |
           ${{ runner.os }}-node-
-
-
-

.github/workflows/codeql-analysis.yml

@@ -38,7 +38,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

.gitignore

@@ -15,5 +15,8 @@ coverage
 yarn.lock
 coverage.lcov
 pnpm-lock.yaml
+lcov.info
 
-dist/
+deno.lock
+
+evaluation

.npmignore

@@ -1,18 +1,7 @@
-node_modules/
-src/
-test-data/
-.idea/
-coverage/
-.vscode/
-
-.DS_Store
-yarn.lock
-coverage.lcov
+node_modules
+coverage
+.github
 pnpm-lock.yaml
-
-*.js
-*.cjs
-*.js.map
-
-!dist/**/*.js
-!index.js
+examples
+test-data
+lcov.info

CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Contributing to `@extractus/article-extractor`
+
+Glad to see you here.
+
+Collaborations and pull requests are always welcomed, though larger proposals should be discussed first.
+
+As an OSS, it's better to follow the Unix philosophy: "do one thing and do it well".
+
+## Third-party libraries
+
+Please avoid using libaries other than those available in the standard library, unless necessary.
+
+This library needs to be simple and flexible to run on multiple platforms such as Deno, Bun, or even browser.
+
+
+## Coding convention
+
+Make sure your code lints before opening a pull request.
+
+
+```bash
+cd article-extractor
+
+# check coding convention issue
+npm run lint
+
+# auto fix coding convention issue
+npm run lint:fix
+```
+
+*When you run `npm test`, the linting process will be triggered at first.*
+
+
+## Testing
+
+Be sure to run the unit test suite before opening a pull request. An example test run is shown below.
+
+```bash
+cd article-extractor
+npm test
+```
+
+![article-extractor unit test](https://i.imgur.com/TbRCUSS.png?110222)
+
+If test coverage decreased, please check test scripts and try to improve this number.
+
+
+## Documentation
+
+If you've changed APIs, please update README and [the examples](examples).
+
+
+## Clean commit histories
+
+When you open a pull request, please ensure the commit history is clean.
+Squash the commits into logical blocks, perhaps a single commit if that makes sense.
+
+What you want to avoid is commits such as "WIP" and "fix test" in the history.
+This is so we keep history on master clean and straightforward.
+
+For people new to git, please refer the following guides:
+
+- [Writing good commit messages](https://github.com/erlang/otp/wiki/writing-good-commit-messages)
+- [Commit Message Guidelines](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53)
+
+
+## License
+
+By contributing to `@extractus/article-extractor`, you agree that your contributions will be licensed under its [MIT license](LICENSE).
+
+---

LICENSE

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