Як увімкнути синтаксис ES6 (і пізніше) за допомогою Node та Express

Ви коли-небудь пробували писати інтерфейсні програми, використовуючи синтаксис ES6, але тоді, коли ви вирішили навчитися внутрішній розробці за допомогою Node.js та Express, ви зрозуміли, що не можете використовувати такі речі, як import fromі   export default? Якщо так, ви потрапили в потрібне місце! Це покрокове керівництво щодо налаштування середовищ для розробників і розробників, сценаріїв налаштування, і в якості бонусу ми дізнаємось, як додавати тести!

Зміст / Короткий зміст тем

  • Як це працює?
  • Передумови
  • Встановлення експрес
  • Налаштування сценаріїв
  • Бонус
  • TL; DR

Як це працює? Погляд на високому рівні того, що нам потрібно

Для того, щоб забезпечити інтерфейсну розробку, подібну до розробки внутрішніх програм, ось докладний огляд процесів, що відбуваються з вашим проектом.

Транспілер коду з ES6 + на ES5

Нам потрібен пакет, який перекладає синтаксис ES6 і вище в код ES5. Код ES5 - це синтаксичний стиль JS, який можна прочитати на node.js, наприклад module.exportsабо var module = require('module'). Зверніть увагу, що в сучасний час майже 99% синтаксису ES6 + можна використовувати в Node.js. Тут блищить упаковка під назвою babel .

Babel бере файл js, перетворює в ньому код і виводить у новий файл.

Сценарій, який видаляє файли

Кожного разу, коли ми щось міняємо у своєму коді, ми подаємо його до транпілятора, і він щоразу видає нову копію. Ось чому нам потрібен скрипт, який видаляє файли до того, як з’явиться нова копійована копія. І для цього існує існуючий пакет під назвою rimraf. Rimraf видаляє файли. Це ми продемонструємо пізніше.

Спостерігач за змінами файлів

При кодуванні в Node.js автоматичний перезапуск нашого сервера не виходить з коробки так само, як при виконанні проекту, створеного поверх create-response-app або vue-cli. Ось чому ми встановимо пакет під назвою nodemon, який виконує щось, коли ми змінюємо файл у коді. Ми можемо використовувати nodemon для перезапуску нашого сервера щоразу, коли файл змінюється.

Отже, це високий погляд на те, як це працює під капотом. З цього, давайте почнемо з того, як нам налаштовувати чи проектувати.

Передумови

Перш ніж розпочати, спочатку нам потрібно налаштувати деякі речі.

  1. Переконайтеся, що у вас встановлені Node.js та npm. Я рекомендую встановити їх останню LTS або поточну стабільну версію. Ви можете встановити його через Node.js Source або NVM (Node Version Manager)
  2. Базові знання команд терміналу. Більшість команд у будь-якому випадку містяться в підручнику, тому вам не доведеться про них турбуватися.
  3. Переконайтеся, що ваш термінал відкритий і встановлений ваш улюблений текстовий редактор.

Ось і все, нам добре їхати!

Встановлення Express

За допомогою генератора Express ми створимо новий проект із згенерованим кодом, перемістимо деякі файли та перетворимо деякий код у синтаксис ES6. Нам потрібно перетворити його на цьому ранньому етапі, оскільки нам потрібен спосіб перевірити, чи працює наш код ES6.

Налаштування проекту

Запустіть цю команду у своєму терміналі. Ви можете назвати your-project-nameім’я, яке вам подобається. --no-viewпрапорець означає, що ми не будемо використовувати будь-який шаблонний механізм, такий як кермо, ejs або мопс, для нашої програми-скелета Express.

npx express-generator your-project-name --no-view

Після створення програми вам потрібно перейти до каталогу програми. Для терміналів Windows Powershell та Linux використовуйте:

cd your-project-name

Далі відкрийте текстовий редактор, який вам подобається. Для мене я просто використовую VSCode, тому просто відкриваю термінал і текстовий редактор одночасно. Але ви можете використовувати будь-який редактор тексту, який хочете.

Встановлення пакетів та переміщення та видалення файлів

Після того, як ми підготували згенерований проект, нам потрібно перейти installдо залежностей та перемістити деякі папки. Виконайте цю команду, щоб встановити Express та інші пакети.

npm встановити

Поки ви чекаєте встановлення залежностей, виконайте такі дії.

  • створити server/папку
  • Поміщений bin/, app.jsі routes/всередині server/папки.
  • Rename www, знайдений в binдоwww.js
  • Залиште public/папку в корені проекту.

Ваша файлова структура буде виглядати так:

Тепер, оскільки ми змінили структуру файлу, наш сценарій запуску сервера не працюватиме. Але ми це виправимо по дорозі.

Перетворення в код ES6

Перетворення згенерованого коду в ES6 трохи нудне, тому я просто опублікую код тут і не соромлюся скопіювати та вставити його.

Код для bin/www.js:

Тепер, оскільки ми змінили структуру файлу, наш сценарій запуску сервера не працюватиме. Ось що ми зробимо, щоб це виправити. У вашому файлі package.json перейменуйте стартовий скрипт, який буде serverзнайдено у JSON-об’єкті"scripts"

// package.json { "name": "your-project-name", // ....other details "scripts": { "server": "node ./server/bin/www" } }

Ви побачите, що ми змінили шлях до файлу з ./bin/wwwна, ./server/bin/wwwоскільки ми перемістили файли в server/. Пізніше ми використаємо скрипт запуску.

Спробуй це! Спробуйте запустити сервер, набравши npm run serverна своєму терміналі, і перейдіть до localhost:3000у своєму браузері.

Перетворення коду верхнього рівня для використання імпорту ES6

Перетворення згенерованого коду в ES6 трохи нудне, тому я просто опублікую код тут і не соромлюся скопіювати та вставити його.

Код для bin/www.js:

// bin/www.js /** * Module dependencies. */ import app from '../app'; import debugLib from 'debug'; import http from 'http'; const debug = debugLib('your-project-name:server'); // ..generated code below.

Almost all of our modifications are only at the top and bottom of the files. We are leaving other generated code as is.

Code for routes/index.js and routes/users.js:

// routes/index.js and users.js import express from 'express'; var router = express.Router(); // ..stuff below export default router;

Code for app.js:

// app.js import express from 'express'; import path from 'path'; import cookieParser from 'cookie-parser'; import logger from 'morgan'; import indexRouter from './routes/index'; import usersRouter from './routes/users'; var app = express(); app.use(logger('dev')); app.use(express.json()); app.use(express.urlencoded({ extended: false })); app.use(cookieParser()); app.use(express.static(path.join(__dirname, '../public'))); app.use('/', indexRouter); app.use('/users', usersRouter); export default app;

In app.js , because we left public/ at the project root , we need to change the Express static path one folder up. Notice that the path 'public' became '../public' .

app.use(express.static(path.join(__dirname, '../public')));

Okay we’re done with converting the code! Let’s setup our scripts now.

Setting up Scripts

In setting up scripts, each script performs a different role. And we reuse each npm script. And for our development and production environments, they have a different configuration. (Almost identical, you’ll see later) That’s why we need to compose our scripts so we can use them without repeatedly typing the same stuff all over again.

Install `npm-run-all`

Since some terminal commands won’t work on windows cmd, we need to install a package called npm-run-all so this script will work for any environment. Run this command in your terminal project root.

npm install --save npm-run-all

Install babel, nodemon, and rimraf

Babel is modern JavaScript transpiler. A transpiler means your modern JavaScript code will be transformed to an older format that Node.js can understand. Run this command in your terminal project root. We will be using the latest version of babel (Babel 7+).

Note that Nodemon is our file watcher and Rimraf is our file remover packages.

npm install --save @babel/core @babel/cli @babel/preset-env nodemon rimraf

Adding transpile script

Before babel starts converting code, we need to tell it which parts of the code to translate. Note that there are a lots of configuration available, because babel can convert a lot of JS Syntaxes for every different kinds of purpose. Luckily we don’t need to think about that because there’s an available default for that. We are using default config called as preset-env (the one we installed earlier) in our package.json file to tell Babel in which format we are transpiling the code.

Inside your package.json file, create a "babel" object and put this setting.

// package.json { // .. contents above "babel": { "presets": ["@babel/preset-env"] }, }

After this setup we are now ready to test if babel really converts code. Add a script named transpile in your package.json:

// package.json "scripts": { "start": "node ./server/bin/www", "transpile": "babel ./server --out-dir dist-server", }

Now what happened here? First we need to run the cli command babel , specify the files to convert, in this case, the files in server/ and put the transpiled contents in a different folder called dist-server in our project root.

You can test it by running this command

npm run transpile

You’ll see a new folder pop up.

Yay it worked! ✅ As you can see, there’s a folder that has the same folder structure as our server folder but with converted code inside. Pretty cool right? Next step is to run try if our server is running!

Clean script

To have a fresh copy every-time we transpile code into new files, we need a script that removes old files. Add this script to your package.json

"scripts": { "server": "node ./dist-server/bin/www", "transpile": "babel ./server --out-dir dist-server", "clean": "rimraf dist-server" }

This npm script that we made means it removes the folder dist-server/

Now to combine transpile and clean, add a script called build , which combines the two processes.

// scripts "build": "npm-run-all clean transpile"

Running dev script

Now we have a build script, we need to run our dev server. We’ll add a script called dev in our package.json. This takes care of setting our Node Environment to “development”, removing old transpiled code, and replacing it with a new one.

"scripts": { "build": "npm-run-all clean transpile" "server": "node ./dist-server/bin/www", "dev": "NODE_ENV=development npm-run-all build server", "transpile": "babel ./server --out-dir dist-server", "clean": "rimraf dist-server" }

Note here that we’ve changed again the file we are running on our server script. We’re running the file-path with the transpiled code, found in dist-server/.

Adding prod scripts

If we have a dev script that sets the Node Environment to development, we have a prod script that sets it to “production.” We use this configuration when we are deploying. (Heroku, AWS, DigitalOcean, etc..) We’re now adding again our start script and prod script in our package.json again.

"scripts": { "start": "npm run prod" "build": "npm-run-all clean transpile" "server": "node ./dist-server/bin/www", "dev": "NODE_ENV=development npm-run-all build server", "prod": "NODE_ENV=production npm-run-all build server", "transpile": "babel ./server --out-dir dist-server", "clean": "rimraf dist-server" }

We set start script default to prod because start script is being used always by deployment platforms like AWS or Heroku to start a server.

Try either by running npm start or npm run prod .

// package.json ... "nodemonConfig": { "exec": "npm run dev", "watch": ["server/*", "public/*"], "ignore": ["**/__tests__/**", "*.test.js", "*.spec.js"] }, "scripts": { // ... other scripts "watch:dev": "nodemon" }

How about auto-restarting the server whenever a file change?

One final script, in order to complete our development setup. We need to add a file watcher script that runs a command whenever a change is made in a file. Add a JSON Object named “nodemonConfig” in your package.json. This is where we store what we tell the watcher what to do when a file changes.

Also, add a script called watch:dev in your package.json

// package.json ... "nodemonConfig": { "exec": "npm run dev", "watch": ["server/*", "public/*"], "ignore": ["**/__tests__/**", "*.test.js", "*.spec.js"] }, "scripts": { // ... other scripts "watch:dev": "nodemon" }

Nodemon config contains settings related to

  • Which command to run whenever a file changes, in our case npm run dev
  • What folders and files to watch
  • And which files to ignore

More about configuration of nodemon here.

Now that we have our file watcher, you can now just run npm run watch:dev , code, and save your file. and whenever you go to localhost:3000 , you’ll see the changes. Try it out!

Bonus: Add tests!

To add tests in our project, simply install Jest from npm, add a few config, and add a script called test in our package.json

npm i -D jest

Add an object called “jest”, and a test script in your package.json

// package.json ... "jest": { "testEnvironment": "node" }, "scripts": { // ..other scripts "test": "jest" }

Try it out, make a file sample.test.js, write any tests, and run the script!

npm run test

TL;DR

Here are the simplified steps for how to enable ES6 in Node.js. I’ll also include the repo so you can copy and inspect the whole code.

  • Make a new project using express your-project-name terminal command.
  • Move the bin/, routes/ and app into a new folder called src/ , and convert the code into ES6. Also don’t forget to rename bin/www to www.js
  • Install all the dependencies and devDependencies
npm i npm-run-all @babel/cli @babel/core @babel/preset-env nodemon rimraf --save npm i -D jest
  • Add these scripts to your package.json
"scripts": { "start": "npm run prod", "build": "npm-run-all clean transpile", "server": "node ./dist-server/bin/www", "dev": "NODE_ENV=development npm-run-all build server", "prod": "NODE_ENV=production npm-run-all build server", "transpile": "babel ./server --out-dir dist-server", "clean": "rimraf dist-server", "watch:dev": "nodemon", "test": "jest" }
  • Put configurations for babel, nodemon, and jest in your package.json
"nodemonConfig": { "exec": "npm run dev", "watch": [ "server/*", "public/*" ], "ignore": [ "**/__tests__/**", "*.test.js", "*.spec.js" ] }, "babel": { "presets": [ "@babel/preset-env" ] }, "jest": { "testEnvironment": "node" },
  • Test your scripts by running npm run your-script-here
  • You’ll see the complete repo at my github

Notes and disclaimers

Note that this setup may not be proved ideal for all situations, specially for big projects. (like 1k files of code). Transpiling step and deleting might slow down your development environment. Plus, ES Modules, is almost coming to node. But, nevertheless, this is a good eductational material to understand how transipiling runs under the hood like when we are developing front-end apps :)

Conclusion

All right! I hope you learned a lot. Thank you for reading this far.

Happy Coding!

Check the full repo here.

This article is published in freeCodecamp news.

? Twitter - ? freeCodeCamp -  ? Portfolio - ⚛️ Github