memasang tools eslint, memulai projek noteapp back end dengan kriteria

Author: uciharis

17g-buildRESTfulAPI-hapi.js

@@ -20,7 +20,8 @@
 // } ,
 // lalu jalankan "npm run start"
 // output :
-/**
+/*
+*
  * 
  * > [email protected] start
 > nodemon server.js
@@ -30,7 +31,48 @@
 [nodemon] watching path(s): *.*
 [nodemon] watching extensions: js,mjs,json
 [nodemon] starting `node server.js`
- halo kita akan membuat RESTful API !
+halo kita akan membuat RESTful API !
 [nodemon] clean exit - waiting for changes before restart
  */
-// nodemon berhasil dieksekusi ! kita tdk perlu menjalankan ulang npm run start karna dijalankan otomatis menggunakan nodemon
+// nodemon berhasil dieksekusi ! kita tdk perlu menjalankan ulang npm run start karna dijalankan otomatis menggunakan nodemon
+
+// -- menggunakan tools eslint
+// eslint membantu kita menulis kode secara konsisten. 
+// ada beberapa aturan dan gaya penulisan kode seperti
+// Airbnb JS code style : https://github.com/airbnb/javascript
+// google JS style : https://google.github.io/styleguide/jsguide.html
+// dan standardJS style : https://standardjs.com/
+
+// utk menggunakan eslint, pasang package pada devDependencies proyek. caranya dengan
+// install packagenya "npm install eslint --save-dev"
+// setelah instal, akan muncul eslint terpasang di package.json
+
+// sblum digunakan, perlu dikonfgurasi dulu dengan cara "npx elsint --init"
+// lalu ikuti petunjuk berikut:
+// 1. pilih would to use ESLint "to check, find problems and enforce code style"
+// 2. pilih type of modules "CommonJS"
+// 3. pilih framework "none of these"
+// 4. pilih does project use Ts "No"
+// 5. pilih where does run code "Node"
+// 6. pilih how define a style for project "Use a popular style guide"
+// 7. pilih style guide want to follow "google style"
+// 8. pilih which format your config to be in "JSON"
+// 9. sisanya pilih semua "Y"
+// setelah berhasil. cek ".eslintrc.json" di folder notes_app_back_end
+// tambahkan npm runner ke package.json
+// "lint" : "eslint ./"
+// lalu jalankan npm run lint , hasilnya akan seperti ini:
+/* -- output ---
+ * > [email protected] lint
+> eslint ./
+
+
+/home/x260/Documents/dicoding-JS/notes-app-back-end/server.js
+  1:55  error  Newline required at end of file but not found  eol-last
+
+✖ 1 problem (1 error, 0 warnings)
+  1 error and 0 warnings potentially fixable with the `--fix` option.
+ * 
+ */
+
+  // dengan error tsb kita dapat melihat letak kesalahan penulisan kode kita sesuai dg style guide yang kita pilih

18-kriteria-proyek.js

@@ -0,0 +1,62 @@
+// --- KRITERIA PROYEK ---
+// kita akan membangun RESTful API utk membuat aplikasi catatan sederhana
+// dimana aplikasi tsb berfungsi utk create, read, update dan delete atau dikenal dengan istlilah CRUD
+// dari segi client, sudah dideploy aplikasinya dengan alamat berikut:
+// http://notesapp-v1.dicodingacademy.com/
+// namun aplikasi tsb tidak bs digunakan, karna blm terhubung dg RESTful API
+
+// kriteria 1- web server dapat menyimpan catatan
+// menyimpan tanpa perlu ke server, ckup ke memory server dalam bentuk array
+// berikut struktur objek catatannya :
+/**
+ * {
+ id: string,
+ title: string,
+ createdAt: string,
+ updatedAt: string,
+ tags: array of string,
+ body: string,
+},
+ */
+
+// contoh nyata sbb:
+/**
+ * {
+ id: 'notes-V1StGXR8_Z5jdHi6B-myT',
+ title: 'Sejarah JavaScript',
+ createdAt: '2020-12-23T23:00:09.686Z',
+ updatedAt: '2020-12-23T23:00:09.686Z',
+ tags: ['NodeJS', 'JavaScript'],
+ body: 'JavaScript pertama kali dikembangkan oleh Brendan Eich dari Netscape di bawah nama Mocha, yang nantinya namanya diganti menjadi LiveScript, dan akhirnya menjadi JavaScript. Navigator sebelumnya telah mendukung Java untuk lebih bisa dimanfaatkan para pemrogram yang non-Java.',
+},
+ */
+// agar web server dpt simpan catatan, web server harus sediakan route dg path '/notes' dan metod POST
+// client akan kirim req ke path dan metod tsb dg bawa data JSON berikut pada req body
+/**
+ * {
+ "title": "Judul Catatan",
+ "tags": ["Tag 1", "Tag 2"],
+ "body": "Konten catatan"
+}
+ */
+// properti id, createdAt, dan updatedAt harus di olah di server, client tidak akan kirim itu
+// server harus memasikan id selalu unik
+// jika req client berhasil, respon dr server harus memiliki status code 201(created) dan kembalikan data berformat JSON sbb:
+/**
+ * {
+  "status": "success",
+  "message": "Catatan berhasil ditambahkan",
+  "data": {
+    "noteId": "V09YExygSUYogwWJ"
+  }
+}
+ */
+
+// nilai dr properti nodeId diambil dari properti id yang dibuat unik
+// bila req gagal, kirim status code 500 dan kembalikan dg dta JSON dengan format :
+/**
+ * {
+  "status": "error",
+  "message": "Catatan gagal untuk ditambahkan"
+}
+ */

notes-app-back-end/.eslintrc.json

@@ -0,0 +1,15 @@
+{
+    "env": {
+        "browser": true,
+        "commonjs": true,
+        "es2021": true
+    },
+    "extends": "google",
+    "overrides": [
+    ],
+    "parserOptions": {
+        "ecmaVersion": "latest"
+    },
+    "rules": {
+    }
+}