Как да активирам ES6 (и по-нататък) синтаксис с Node и Express

Опитвали ли сте някога да пишете приложения отпред, като използвате синтаксис ES6, но след това, когато решихте да научите back-end разработка с Node.js и Express, осъзнахте, че не можете да използвате неща като import fromи   export default? Ако е така, попаднали сте на правилното място! Това е ръководство стъпка по стъпка как да конфигурирате вашата среда за разработчици и разработчици, скриптове за настройка и като бонус ще научим как да добавяте тестове!

Съдържание / Обобщение на темите

  • Как работи?
  • Предпоставки
  • Инсталиране на express
  • Настройване на скриптове
  • Бонус
  • 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/папката.
  • Преименуване 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