NodeとExpressでES6(およびそれ以降)の構文を有効にする方法

ES6構文を使用してフロントエンドアプリを作成しようとしたことがありますが、Node.jsとExpressを使用してバックエンド開発を学ぶことにしたとき、import fromやの  ようなものは使用できないことに気付きましたexport defaultか?もしそうなら、あなたは正しい場所に来ました!これは、開発環境と製品環境の構成方法、スクリプトのセットアップ方法に関するステップバイステップガイドです。ボーナスとして、テストを追加する方法を学習します。

目次/トピックの要約

  • それはどのように機能しますか?
  • 前提条件
  • Expressのインストール
  • スクリプトの設定
  • ボーナス
  • TL; DR

それはどのように機能しますか?必要なものの概要

バックエンドアプリの開発中にフロントエンド開発のようなエクスペリエンスを実現するために、プロジェクトで発生しているプロセスの概要を以下に示します。

ES6 +からES5へのコードトランスパイラー

ES6以降の構文をES5コードに変換するパッケージが必要です。ES5コードは、次のような、Node.jsのに読み取り可能なJS構文形式ですmodule.exportsvar module = require('module')。今日では、ES6 +構文のほぼ99%がNode.jsで使用できることに注意してください。ここで、babelというパッケージが光ります。

Babelはjsファイルを受け取り、その中のコードを変換して、新しいファイルに出力します。

ファイルを削除するスクリプト

コード内で何かを変更するたびに、それをトランスパイラーにフィードし、毎回新しいコピーを出力します。そのため、新しくトランスパイルされたコピーが入る前にファイルを削除するスクリプトが必要です。そのために、rimrafと呼ばれる既存のパッケージがあります。Rimrafはファイルを削除します。これについては後で説明します。

ファイル変更の監視者

Node.jsでコーディングする場合、create-react-appまたはvue-cliの上で作成されたプロジェクトを実行するときのように、サーバーの自動再起動はすぐには使用できません。そのため、コード内のファイルを変更するたびに何かを実行するnodemonというパッケージをインストールします。nodemonを利用して、ファイルが変更されるたびにサーバーを再起動できます。

これが、内部でどのように機能するかについての概要です。それでは、どのようにセットアップまたはプロジェクトを行うべきかから始めましょう。

前提条件

始める前に、まずいくつかの設定が必要です。

  1. Node.jsとnpmがインストールされていることを確認してください。最新のLTSまたは現在の安定バージョンをインストールすることをお勧めします。Node.jsソースまたはNVM(ノードバージョンマネージャー)を介してインストールできます
  2. ターミナルコマンドの基本的な知識。とにかくほとんどのコマンドはチュートリアルに含まれているので、心配する必要はありません。
  3. ターミナルが開いていて、お気に入りのテキストエディタがインストールされていることを確認してください。

それだけです、私たちは行ってもいいです!

Expressのインストール

Expressジェネレーターを使用して、生成されたコードで新しいプロジェクトを作成し、いくつかのファイルを移動し、いくつかのコードをES6構文に変換します。ES6コードが機能するかどうかを確認する方法が必要なため、この早い段階で変換する必要があります。

プロジェクトの設定

ターミナルでこのコマンドを実行します。your-project-name好きな名前で名前を付けることができます。--no-viewflagは、スケルトンExpressアプリに、ハンドルバー、ejs、パグなどのテンプレートエンジンを使用しないことを意味します。

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ファイルで、startスクリプトの名前をserverJSONオブジェクトにある名前に変更します。"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