chore: use ESM

.eslintrc.js → .eslintrc.cjs

@@ -1,7 +1,15 @@
 module.exports = {
   root: true,
+  env: {
+    es6: true,
+    node: true,
+  },
+  parserOptions: {
+    sourceType: 'module',
+    ecmaVersion: 12,
+  },
   extends: [
-    'airbnb-base',
+    'eslint:recommended',
     'plugin:prettier/recommended',
     'plugin:jest/recommended',
   ],

.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,14 +4,14 @@ about: Create a report to help us improve
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,15 +24,17 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
 
 **Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -4,7 +4,6 @@ about: Suggest an idea for this project
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
 **Is your feature request related to a problem? Please describe.**

.github/workflows/ci.yml

@@ -1,5 +1,5 @@
 name: CI
-on: [push, pull_request]
+on: [push]
 
 jobs:
   audit:
@@ -16,24 +16,11 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12.x, 14.x]
+        node-version: [12.x, 14.x, 15.x]
 
     steps:
       - uses: actions/checkout@v2
       - name: Install dependencies
         run: yarn install --frozen-lockfile
       - name: Run tests
         run: yarn test
-
-  # publish:
-  #   name: publish
-  #   needs: tests
-  #   runs-on: ubuntu-latest
-  #   if: github.event_name == 'push' && github.ref == 'refs/heads/master'
-  #   steps:
-  #     - uses: actions/checkout@v2
-  #     - name: Publish
-  #       uses: mikeal/merge-release@master
-  #       env:
-  #         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-  #         NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

.npmignore

@@ -7,7 +7,6 @@
 .c9
 .nvm
 .eslintrc.js
-external.jsdoc
 examples/
 docs/
 jsdoc/

.nvmrc

@@ -1 +1 @@
-lts/erbium
+lts/fermium

.prettierignore

@@ -1,2 +1,3 @@
-test/files/v2/wrong_syntax.json
-test/files/v2/wrong_syntax.yaml
+test/fixtures/wrong/example.js
+test/fixtures/wrong/example.json
+test/fixtures/wrong/example.yaml

README.md

@@ -27,7 +27,7 @@ app.get('/', (req, res) => {
 The library will take the contents of `@openapi` (or `@swagger`) with the following configuration:
 
 ```javascript
-const swaggerJsdoc = require('swagger-jsdoc');
+import swaggerJsdoc from 'swagger-jsdoc';
 
 const options = {
   definition: {
@@ -47,15 +47,9 @@ The resulting `openapiSpecification` will be a [swagger tools](https://swagger.i
 
 ![swagger-jsdoc example screenshot](./docs/screenshot.png)
 
-## Node.js version requirements, CommonJS and ESM
+## System requirements
 
-`swagger-jsdoc` 6.x requires Node.js 12.x and above. When using the CLI, the library will attempt to load the definition file in several formats: `.js`, `.cjs`, `.yaml` (or `.yml`) and `.json`.
-
-The example above follows the CommonJS format, which will work when you do not have `"type": "module"` in your `package.json`.
-
-However, if you're using ESM and have `"type": "module"`, then please change the extension to `.cjs`.
-
-Definition files in `.js` and ESM will be supported in `swagger-jsdoc` 7.x.
+Notes on CJS and ESM.
 
 ## Installation
 

docs/CONCEPTS.md

@@ -12,10 +12,10 @@ Parts of the specification can be placed in annotated JSDoc comments in non-comp
 
 Other parts of the specification can be directly written in YAML files. These are usually parts containing static definitions which are referenced from jsDoc comments parameters, components, anchors, etc. which are not so relevant to the API implementation.
 
-Given the following definition `swaggerDefinition.cjs`:
+Given the following definition `definition.js`:
 
 ```javascript
-module.exports = {
+export default {
   info: {
     title: 'Hello World',
     version: '1.0.0',
@@ -24,20 +24,22 @@ module.exports = {
 };
 ```
 
-The end `swaggerSpecification` will be a result of following:
+The end `openapiSpecification` will be a result of following:
 
 ```javascript
-const swaggerJsdoc = require('swagger-jsdoc');
-const swaggerDefinition = require('./swaggerDefinition');
+import swaggerJsdoc from 'swagger-jsdoc';
+import definition from './definition.js';
 
 const options = {
-  swaggerDefinition,
+  definition,
   apis: ['./src/routes*.js'],
 };
 
 const swaggerSpecification = swaggerJsdoc(options);
 ```
 
+Please note that it's also possible to use CommonJS syntax with `require` and `module.exports` for the example above.
+
 ## File selection patterns
 
 `swagger-jsdoc` uses [node glob](https://github.com/isaacs/node-glob) for discovering your input files. You can use patterns such as `*.js` to select all javascript files or `**/*.js` to select all javascript files in sub-folders recursively.

docs/FIRST-STEPS.md

@@ -7,10 +7,10 @@ The default target specification is 2.0. This provides backwards compatibility f
 In order to create a specification compatibile with 3.0 or higher, i.e. the so called OpenAPI, set this information in the `swaggerDefinition`:
 
 ```diff
-const swaggerJsdoc = require('swagger-jsdoc');
+import swaggerJsdoc from 'swagger-jsdoc';
 
 const options = {
-  swaggerDefinition: {
+  definition: {
 +   openapi: '3.0.0',
     info: {
       title: 'Hello World',
@@ -20,7 +20,7 @@ const options = {
   apis: ['./src/routes*.js'],
 };
 
-const swaggerSpecification = swaggerJsdoc(options);
+const openapiSpecification = swaggerJsdoc(options);
 ```
 
 ## Annotating source code

docs/README.md

@@ -3,7 +3,6 @@
 Quick-start:
 
 - [First steps](./FIRST-STEPS.md)
-- [CLI](./CLI.md)
 - [Examples](../examples)
 
 Before you submit an issue: