Development & Project Information for dotlottie-js

This page provides information for developers interested in the dotlottie-js project setup, build process, or contributing.

Source Code Repository

The source code for dotlottie-js is hosted on GitHub:

• Repository URL: https://github.com/dotlottie/dotlottie-js

Here you can find the latest code, report issues, and contribute.

Project Setup and Building

Refer to the README.md and potentially CONTRIBUTING.md files in the repository root for instructions on:

• Cloning the repository.

• Installing development dependencies (likely using pnpm install, npm install, or yarn install).

• Running development scripts (e.g., for building the library, running tests, linting).

Project Structure

A typical structure for a TypeScript library like dotlottie-js might look like this (actual structure may vary):

• /src/: Contains the TypeScript source code for the library.

  • /v1/: Source code specific to V1 dotLottie format handling.

  • /v2/: Source code specific to V2 dotLottie format handling (e.g., DotLottie class).

  • /common/: Shared utilities and types.

  • index.ts: Main entry point for the library.

• /dist/: Contains the distributable/compiled JavaScript files (e.g., ESM, UMD, CJS builds).

• /examples/: Sample usage and example projects.

• /tests/ or /__tests__/: Unit and integration tests (e.g., using Jest, Vitest, or similar).

• package.json: Project metadata, dependencies, and scripts.

• tsconfig.json: TypeScript compiler configuration.

• rollup.config.js / webpack.config.js / vite.config.js: Bundler configuration (if used).

• README.md: Main project readme.

• CONTRIBUTING.md: Guidelines for contributors.

• LICENSE: Project license information.

Build Process

dotlottie-js is likely built using:

• TypeScript: For type safety and modern JavaScript features.

• Bundler (e.g., Rollup, Webpack): To create distributable bundles for different environments (browser ESM, Node.js ESM/CJS, UMD).

• Testing Framework (e.g., Jest, Vitest): To ensure code correctness.

• Linter/Formatter (e.g., ESLint, Prettier): To maintain code style and quality.

The specific build commands can be found in the package.json scripts section.

Running Tests

Tests are crucial for maintaining the library's stability.

# Run tests (check package.json for the exact script name)
npm test
# or
yarn test

Contribution Guidelines

To contribute to dotlottie-js, refer to the CONTRIBUTING.md file in the repository root for detailed information on:

• Code style conventions.

• Branching strategy.

• Testing requirements.

• Pull request process.

Generally, the process involves:

1. Fork the repository.

2. Create a feature or bugfix branch.

3. Make your changes, including tests.

4. Ensure all tests and linters pass.

5. Submit a pull request to the main repository, clearly describing your changes.

Reporting Issues

Use the Issues tab on the GitHub repository to report bugs, request features, or ask questions:

• Report an Issue: https://github.com/dotlottie/dotlottie-js/issues

When reporting bugs, please provide:

• Clear description of the issue.

• dotlottie-js version.

• Environment (Browser/Node.js version, OS).

• Steps to reproduce the issue.

• Code samples (if applicable).

• Any relevant error messages.

License

The license under which dotlottie-js is distributed can be found in the LICENSE file in the repository root. Please review it before using or contributing to the project.

This completes the documentation for dotlottie-js within this wiki.