feat: Use ES modules (#727)

Author: GrosSacASac

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+### Unreleased 3.0
+
+ * feat: Use ES modules ([727](https://github.com/node-formidable/formidable/pull/727))
+ * options.enabledPlugins must contain the plugin themselves instead of the plugins names 
+
+
 ### Unreleased (`canary` & `dev` dist-tags)
 
  * feat: add options.filter ([#716](https://github.com/node-formidable/formidable/pull/716))

README.md

@@ -104,8 +104,8 @@ Parse an incoming file upload, with the
 [Node.js's built-in `http` module](https://nodejs.org/api/http.html).
 
 ```js
-const http = require('http');
-const formidable = require('formidable');
+import http from 'http';
+import formidable from 'formidable';
 
 const server = http.createServer((req, res) => {
   if (req.url === '/api/upload' && req.method.toLowerCase() === 'post') {
@@ -152,8 +152,8 @@ Or try the
 [examples/with-express.js](https://github.com/node-formidable/formidable/blob/master/examples/with-express.js)
 
 ```js
-const express = require('express');
-const formidable = require('formidable');
+import express from 'express';
+import formidable from 'formidable';
 
 const app = express();
 
@@ -198,8 +198,8 @@ which is Node.js's Request, and **NOT** the `ctx.request` which is Koa's Request
 object - there is a difference._
 
 ```js
-const Koa = require('koa');
-const formidable = require('formidable');
+import Koa from 'Koa';
+import formidable from 'formidable';
 
 const app = new Koa();
 
@@ -298,20 +298,8 @@ _Please pass [`options`](#options) to the function/constructor, not by assigning
 them to the instance `form`_
 
 ```js
-const formidable = require('formidable');
+import formidable from 'formidable';
 const form = formidable(options);
-
-// or
-const { formidable } = require('formidable');
-const form = formidable(options);
-
-// or
-const { IncomingForm } = require('formidable');
-const form = new IncomingForm(options);
-
-// or
-const { Formidable } = require('formidable');
-const form = new Formidable(options);
 ```
 
 ### Options
@@ -396,8 +384,6 @@ Parses an incoming Node.js `request` containing form data. If `callback` is
 provided, all fields and files are collected and passed to the callback.
 
 ```js
-const formidable = require('formidable');
-
 const form = formidable({ multiples: true, uploadDir: __dirname });
 
 form.parse(req, (err, fields, files) => {
@@ -521,8 +507,6 @@ Formidable instance (the `form` across the README examples) and the options.
 **Note:** the plugin function's `this` context is also the same instance.
 
 ```js
-const formidable = require('formidable');
-
 const form = formidable({ keepExtensions: true });
 
 form.use((self, options) => {
@@ -547,11 +531,10 @@ which is used in [src/plugins/multipart.js](./src/plugins/multipart.js)), then
 you can remove it from the `options.enabledPlugins`, like so
 
 ```js
-const { Formidable } = require('formidable');
-
-const form = new Formidable({
+import formidable, {octetstream, querystring, json} from "formidable";
+const form = formidable({
   hashAlgorithm: 'sha1',
-  enabledPlugins: ['octetstream', 'querystring', 'json'],
+  enabledPlugins: [octetstream, querystring, json],
 });
 ```
 

examples/json.js

@@ -1,8 +1,7 @@
-'use strict';
+import http from 'http';
+import util from 'util';
+import formidable from '../src/index.js';
 
-const http = require('http');
-const util = require('util');
-const { formidable } = require('../src/index');
 
 const PORT = 3000;
 const server = http.createServer((req, res) => {

examples/log-file-content-to-console.js

@@ -1,8 +1,7 @@
-'use strict';
+import http from 'http';
+import { Writable } from 'stream';
+import formidable from '../src/index.js';
 
-const http = require('http');
-const { Writable } = require('stream');
-const formidable = require('../src/index');
 
 const server = http.createServer((req, res) => {
   if (req.url === '/api/upload' && req.method.toLowerCase() === 'post') {

examples/multipart-parser.js

@@ -1,6 +1,5 @@
-'use strict';
+import { MultipartParser } from '../src/index.js';
 
-const { MultipartParser } = require('../src/index');
 
 // hand crafted multipart
 const boundary = '--abcxyz';

examples/multiples.js

@@ -1,8 +1,7 @@
-'use strict';
+import http from 'http';
+import os from 'os';
+import formidable from '../src/index.js';
 
-const os = require('os');
-const http = require('http');
-const { Formidable } = require('../src/index');
 
 const server = http.createServer((req, res) => {
   if (req.url === '/') {
@@ -28,7 +27,7 @@ const server = http.createServer((req, res) => {
       </form>
     `);
   } else if (req.url === '/upload') {
-    const form = new Formidable({ multiples: true, uploadDir: os.tmpdir() });
+    const form = formidable({ multiples: true, uploadDir: os.tmpdir() });
 
     form.parse(req, (err, fields, files) => {
       res.writeHead(200, { 'Content-Type': 'application/json' });

examples/store-files-on-s3.js

@@ -1,12 +1,10 @@
 // To test this example you have to install aws-sdk nodejs package and create a bucket named "demo-bucket"
 
-'use strict';
+import http from 'http';
+import { PassThrough } from 'stream';
+import AWS from 'aws-sdk';
+import formidable from '../src/index.js';
 
-const http = require('http');
-const { PassThrough } = require('stream');
-// eslint-disable-next-line import/no-unresolved
-const AWS = require('aws-sdk');
-const formidable = require('../src/index');
 
 const s3Client = new AWS.S3({
   credentials: {

examples/upload-multiple-files.js

@@ -1,10 +1,8 @@
-'use strict';
+import http from 'http';
+import util from 'util';
+import os from 'os';
+import formidable from '../src/index.js';
 
-const os = require('os');
-const http = require('http');
-const util = require('util');
-
-const { Formidable } = require('../src/index');
 
 const server = http.createServer((req, res) => {
   if (req.url === '/') {
@@ -17,7 +15,7 @@ const server = http.createServer((req, res) => {
       </form>
     `);
   } else if (req.url === '/upload') {
-    const form = new Formidable({ multiples: true, uploadDir: os.tmpdir() });
+    const form = formidable({ multiples: true, uploadDir: os.tmpdir() });
     const files = [];
     const fields = [];
 

examples/urlencoded-no-enctype.js

@@ -1,9 +1,7 @@
-'use strict';
+import http from 'http';
+import util from 'util';
+import formidable from '../src/index.js';
 
-const http = require('http');
-const util = require('util');
-
-const { Formidable } = require('../src/index');
 
 const server = http.createServer((req, res) => {
   if (req.url === '/') {
@@ -16,7 +14,7 @@ const server = http.createServer((req, res) => {
       </form>
     `);
   } else if (req.url === '/post') {
-    const form = new Formidable();
+    const form = formidable();
     const fields = [];
 
     form

examples/with-express.js

@@ -1,7 +1,5 @@
-'use strict';
-
-const express = require('express');
-const formidable = require('../src/index');
+import express from 'express';
+import formidable from '../src/index.js';
 
 const app = express();