Pembangunan Web Tanpa Alat (Bina).-tutorial js-php.cn

Web Development Without (Build) Tooling

Apabila memulakan projek web baharu di mana JavaScript akan digunakan, selalunya perkara pertama yang kami lakukan ialah menyediakan alat binaan dan pembangun. Sebagai contoh, Vite, yang popular hari ini. Anda mungkin tidak menyedari bahawa alat binaan yang rumit tidak diperlukan untuk semua projek JavaScript (web). Malah, kini lebih mudah untuk pergi tanpa sebelum ini seperti yang akan saya tunjukkan dalam artikel ini.

Buat projek baharu dengan fail index.html.

<!doctype html>
<html>
  <head>
  </head>
  <body>
    <p>Hello world</p>
  </body>
</html>

Salin selepas log masuk

Jika anda menggunakan Kod VS, pasang sambungan Pratonton Langsung. Jalankan ia. Ini adalah pelayan fail ringkas dengan muat semula langsung. Anda boleh menggunakan mana-mana pelayan fail, Python disertakan dengan satu terbina dalam:

python3 -m http.server

Salin selepas log masuk

Saya suka Pratonton Langsung, kerana ia menyegarkan halaman secara automatik selepas membuat perubahan pada fail.

Kini anda sepatutnya boleh mengakses fail index.html anda daripada penyemak imbas dan melihat "Hello world".

Seterusnya, buat fail index.js:

console.log("Hello world");

export {};

Salin selepas log masuk

Sertakan dalam index.html anda:

<script type="module" src="./index.js"></script>

Salin selepas log masuk

Buka konsol pembangun dalam penyemak imbas anda. Jika anda melihat "Hello world", anda tahu bahawa ia sedang dimuatkan dengan betul.

Pelayar menyokong modul ECMAScript sekarang. Anda boleh mengimport fail lain untuk kesan sampingannya:

import "./some-other-script.js";

Salin selepas log masuk

atau untuk eksport mereka

import { add, multiply } "./my-math-lib.js";

Salin selepas log masuk

Cukup keren kan? Rujuk panduan MDN di atas untuk maklumat lanjut.

Pakej

Anda mungkin tidak mahu mencipta semula roda, jadi projek anda mungkin akan menggunakan beberapa pakej pihak ketiga. Itu tidak bermakna anda kini perlu mula menggunakan pengurus pakej.

Katakan kami mahu menggunakan superstruct untuk pengesahan data. Kita tidak boleh hanya memuatkan modul dari pelayan fail (tempatan) kita sendiri, tetapi dari mana-mana URL. esm.sh menyediakan modul dengan mudah untuk hampir semua pakej yang tersedia di npm.

Apabila anda melawati https://esm.sh/superstruct, anda dapat melihat bahawa anda diarahkan semula ke versi terkini. Anda boleh memasukkan pakej ini seperti berikut dalam kod anda:

import { assert } from "https://esm.sh/superstruct";

Salin selepas log masuk

Jika anda ingin berada di pihak yang selamat, anda boleh menyematkan versi.

Jenis

Saya tidak tahu tentang anda, tetapi TypeScript memanjakan saya (dan membuat saya malas). Menulis JavaScript biasa tanpa bantuan daripada penyemak jenis terasa seperti menulis di atas tali. Nasib baik, kita juga tidak perlu melupakan pemeriksaan taip.

Sudah tiba masanya untuk menghapuskan npm (walaupun kami tidak akan menghantar sebarang kod yang diberikannya).

npm init --yes
npm install typescript

Salin selepas log masuk

Anda boleh menggunakan pengkompil TypeScript pada kod JavaScript dengan baik! Terdapat sokongan kelas pertama untuknya. Cipta jsconfig.json:

{
  "compilerOptions": {
    "strict": true,
    "checkJs": true,
    "allowJs": true,
    "noImplicitAny": true,
    "lib": ["ES2022", "DOM"],
    "module": "ES2022",
    "target": "ES2022"
  },
  "include": ["**/*.js"],
  "exclude": ["node_modules"]
}

Salin selepas log masuk

Sekarang jalankan

npm run tsc --watch -p jsconfig.json

Salin selepas log masuk

dan buat ralat jenis dalam kod anda. Pengkompil TypeScript harus mengadu:

/** @type {number} **/
const num = "hello";

Salin selepas log masuk

Sebenarnya, ulasan yang anda lihat di atas ialah JSDoc. Anda boleh menganotasi JavaScript anda dengan jenis dengan cara ini. Walaupun ia lebih bertele-tele daripada menggunakan TypeScript, dan anda terbiasa dengannya dengan cepat. Ia juga sangat berkuasa, selagi anda tidak menulis jenis gila (yang anda tidak sepatutnya untuk kebanyakan projek) anda sepatutnya baik.

Jika anda memerlukan jenis yang rumit (pembantu), anda sentiasa boleh menambah beberapa TypeScript dalam fail .d.ts.

Adakah JSDoc hanyalah batu loncatan untuk orang yang terperangkap dengan projek JavaScript yang besar untuk dapat berhijrah secara beransur-ansur ke TypeScript? Saya tidak fikir begitu! Pasukan TypeScript juga terus menambah ciri hebat pada JSDoc + TypeScript, seperti dalam keluaran TypeScript yang akan datang. Autolengkap juga berfungsi hebat dalam Kod VS.

Import peta

Kami belajar cara menambah pakej luaran pada projek kami tanpa alat binaan. Walau bagaimanapun, jika anda membahagikan kod anda dalam banyak modul, menulis URL lengkap berulang kali mungkin agak bertele-tele.

Kami boleh menambah peta import pada bahagian kepala index.html kami:

<script type="importmap">
  {
    "imports": {
      "superstruct": "https://esm.sh/superstruct@1.0.4"
    }
  }
</script>

Salin selepas log masuk

Kini kita boleh mengimport pakej ini dengan

import {} from "superstruct"

Salin selepas log masuk

Seperti projek 'biasa'. Manfaat lain ialah penyiapan dan pengecaman jenis akan berfungsi seperti yang diharapkan jika anda memasang pakej secara setempat.

npm install --save-dev superstruct

Salin selepas log masuk

Perhatikan bahawa versi dalam direktori node_modules anda tidak akan digunakan. Anda boleh mengalih keluarnya dan projek anda akan terus berjalan.

Helah yang saya suka gunakan ialah menambah:

      "cdn/": "https://esm.sh/",

Salin selepas log masuk

Ke peta import saya. Kemudian sebarang projek yang tersedia melalui esm.sh boleh digunakan dengan hanya mengimportnya. Cth.:

import Peer from "cdn/peerjs";

Salin selepas log masuk

Jika anda ingin menarik jenis daripada node_modules untuk pembangunan untuk jenis import ini juga, anda perlu menambah yang berikut pada compilerOptions jsconfig.json anda:

    "paths": {
      "cdn/*": ["./node_modules/*", "./node_modules/@types/*"]
    },

Salin selepas log masuk

Kerahan

Untuk menggunakan projek anda, salin semua fail ke hos fail statik dan anda telah selesai! Jika anda pernah mengusahakan projek JavaScript warisan, anda tahu keperitan mendapatkan kemas kini perkakas binaan yang belum pun berusia 1-2 tahun. Anda tidak akan mengalami nasib yang sama dengan persediaan projek ini.

Testing

If your JavaScript does not depend on browser APIs, you could just use the test runner that comes bundled with Node.js. But why not write your own test runner that runs right in the browser?

/** @type {[string, () => Promise<void> | void][]} */
const tests = [];

/**
 *
 * @param {string} description
 * @param {() => Promise<void> | void} testFunc
 */
export async function test(description, testFunc) {
  tests.push([description, testFunc]);
}

export async function runAllTests() {
  const main = document.querySelector("main");
  if (!(main instanceof HTMLElement)) throw new Error();
  main.innerHTML = "";

  for (const [description, testFunc] of tests) {
    const newSpan = document.createElement("p");

    try {
      await testFunc();
      newSpan.textContent = `✅ ${description}`;
    } catch (err) {
      const errorMessage =
        err instanceof Error && err.message ? ` - ${err.message}` : "";
      newSpan.textContent = `❌ ${description}${errorMessage}`;
    }
    main.appendChild(newSpan);
  }
}

/**
 * @param {any} val
 */
export function assert(val, message = "") {
  if (!val) throw new Error(message);
}

Salin selepas log masuk

Now create a file example.test.js.

import { test, assert } from "@/test.js";

test("1+1", () => {
  assert(1 + 1 === 2);
});

Salin selepas log masuk

And a file where you import all your tests:

import "./example.test.js";

console.log("This should only show up when running tests");

Salin selepas log masuk

Run this on page load:

await import("@/test/index.js"); // file that imports all tests
(await import("@/test.js")).runAllTests();

Salin selepas log masuk

And you got a perfect TDD setup. To run only a section of the tests you can comment out a few .test.js import, but test execution speed should only start to become a problem when you have accumulated a lot of tests.

Benefits

Why would you do this? Well, using fewer layers of abstraction makes your project easier to debug. There is also the credo to "use the platform". The skills you learn will transfer better to other projects. Another advantage is, when you return to a project built like this in 10 years, it will still just work and you don't need to do archeology to try to revive a build tool that has been defunct for 8 years. An experience many web developers that worked on legacy projects will be familiar with.

See plainvanillaweb.com for some more ideas.

Atas ialah kandungan terperinci Pembangunan Web Tanpa Alat (Bina).. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!