Development Package

Copyright © 2024-2025 Dolphin Data Development Ltd. and AIDC Toolkit contributors

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

https://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.

Overview

⚠️ This software is in beta, with production release is scheduled for 2024Q4. To follow the status of that and other projects, go to the AIDC Toolkit projects page.

The AIDC Toolkit dev package contains development artefacts only; it is not intended to be used as anything other than a development dependency.

TypeScript Configuration

All AIDC Toolkit packages are expected to be built the same way, which implies that they all have the same TypeScript configuration. This is supported by the tsconfig.json file in this package. Core changes should be managed in that file, with other packages declaring their own tsconfig.json as follows:

{
  "extends": "@aidc-toolkit/dev/tsconfig.json"
}

Options specific to the package may override or supplement core options if required.

ESLint Configuration

All AIDC Toolkit packages are expected to follow a common coding style (enforced by ESLint), which implies that they all have the same ESLint configuration. This is supported by the eslint-config-template.ts file in this package. Core changes should be managed in that file, with other packages declaring their own eslint.config.js file as follows:

import { esLintConfigAIDCToolkit } from "@aidc-toolkit/dev";

export default esLintConfigAIDCToolkit;

Rules specific to the package may override or supplement core rules if required. If so, the eslint.config.js file should be declared as follows:

import tseslint from "typescript-eslint";
import { esLintConfigAIDCToolkit } from "@aidc-toolkit/dev";
// Additional imports here as required.
// ...

export default tseslint.config(
    ...esLintConfigAIDCToolkit,
    // Additional rules here as required.
    // ...
);

ESLint requires the installation of the eslint package as a development dependency. Other development dependencies may be required if overriding or supplementing the core rules.