Chuyển tới nội dung chính

Quản lý phần đầu bản quyền

Dự án này tự động thêm phần đầu bản quyền vào mọi tệp nguồn TypeScript/JavaScript bằng một tập lệnh riêng.

Phần đầu bản quyền​

Mọi tệp nguồn (.ts, .tsx, .js, .jsx) trong các thư mục frontend/src và backend/src sẽ tự động được thêm phần đầu bản quyền sau:

/*
 * Libre WebUI
 * Copyright (C) 2025 Kroonen AI, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

Cách sử dụng​

Tự động thêm phần đầu​

Phần đầu bản quyền được tự động thêm khi bạn chạy:

npm run format

Lệnh này:

  1. Chạy tập lệnh thêm phần đầu
  2. Định dạng tất cả tệp bằng Prettier

Thêm phần đầu thủ công​

Bạn cũng có thể thêm phần đầu thủ công mà không định dạng:

npm run add-headers

Phát hiện phần đầu thông minh​

Tập lệnh sẽ:

  • ✅ Thêm phần đầu vào các tệp chưa có
  • ✅ Bỏ qua các tệp đã có phần đầu bản quyền
  • ✅ Bỏ qua tệp cấu hình, đầu ra build và dependency
  • ✅ Chỉ xử lý tệp nguồn TypeScript/JavaScript

Tệp/thư mục bị bỏ qua​

Các mục sau tự động bị bỏ qua:

  • node_modules/
  • dist/
  • build/
  • coverage/
  • public/
  • Tệp cấu hình (*.config.js, *.config.ts)
  • Tệp định nghĩa kiểu (vite-env.d.ts)
  • Cấu hình ESLint (eslint.config.js)

Triển khai​

Chức năng quản lý phần đầu được triển khai trong /scripts/add-headers.js và tích hợp vào quy trình định dạng trong package.json.