discord-update-classnames

KO | EN

gitlite — search

#python #llm #go #android #machine-learning #rust #deep-learning #linux #docker #windows #cli #awesome-list #vue #pytorch

discord-update-classnames

(★ 19)

Automated CSS class name synchronization tool for Discord theme developers

discord-update-classnames Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# discord-update-classnames

[![Fetch Data](https://github.com/fedeericodl/discord-update-classnames/actions/workflows/fetch-data.yml/badge.svg)](https://github.com/fedeericodl/discord-update-classnames/actions/workflows/fetch-data.yml)
[![Lint](https://github.com/fedeericodl/discord-update-classnames/actions/workflows/lint.yml/badge.svg)](https://github.com/fedeericodl/discord-update-classnames/actions/workflows/lint.yml)

> [!WARNING]
> :warning: This is not released yet, you can test it by using the `main` branch as the version (`fedeericodl/discord-update-classnames@main`). Please report any issues you find.

The `discord-update-classnames` GitHub action provides automated synchronization of Discord theme class names with the latest changes directly extracted from the client. This tool helps theme developers maintain compatibility by automatically updating CSS class names in their themes and warning about deprecated selectors.

## Features

- **🕵️ Automatic Class Name Scraping**: Regularly collects updated class names (see [data outputs](#data-outputs))

- **🔄 Smart Class Replacement**: Updates outdated class names in theme files while preserving custom styling

- **🚨 Deprecation Warnings**: Identifies and reports class names no longer present in Discord's client

- **🤖 Automated Pull Requests**: Creates PRs with proposed changes for easy review and manual verification

## Usage

Add this to your GitHub Actions workflow (e.g. `.github/workflows/update-classnames.yml`):

```yml
name: Update Discord Class Names
on:
    schedule:
        - cron: "0 0 * * *" # Daily check
    workflow_dispatch:

jobs:
    update:
        runs-on: ubuntu-latest
        steps:
            - uses: actions/checkout@v6

- name: Run Class Name Updater
              uses: fedeericodl/discord-update-classnames@v1
              with:
                  files: "src/theme/"
```

This is the most basic setup. You can customize the action by providing additional options.

### Inputs

The following inputs can be used to customize the action:

| Name                    | Description                                                                                                                        | Default                                         | Required |
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | :------: |
| `files`                 | Files/directories to process (comma/newline separated)                                                                             |                                                 |   Yes    |
| `follow-symbolic-links` | Indicates whether to follow symbolic links when resolving file paths                                                               | `true`                                          |    No    |
| `ignores`               | Files/directories to exclude from processing (comma/newline separated)                                                             |                                                 |    No    |
| `ignore-class-names`    | Class names to ignore during processing (comma/newline separated). Use this for client mod/plugin classes to avoid false positives |                                                 |    No    |
| `report-outdated`       | Indicates whether to fail the action if outdated class names are found, even if no changes were made                               | `false`                                         |    No    |
| `token`                 | GitHub token to use for pull requests creation                                                                                     | `GITHUB_TOKEN`                                  |    No    |
| `target-branch`         | Destination branch for automated changes (creates if missing)                                                                      | `classname-updates`                             |    No    |
| `commit-message`        | Commit message template                                                                                                            | `chore: update Discord class names (automated)` |    No    |
| `pr-title`              | Pull request title template                                                                                                        | `Class Name Updates`                            |    No    |

:exclamation: The `files` input is required and should point to the theme files or directories to process. You can use glob patterns to match multiple files, e.g. `src/theme/**/*.scss`.

When using this action with themes that include styling for client mods (like BetterDiscord, Vencord, etc.) or plugins, you should specify their class names in the `ignore-class-names` input. Otherwise, these class names will be reported as "failed" or "outdated" since they don't exist in the vanilla Discord client.

### Outputs

The action provides the following outputs:

- `version-hash`: Discord client build version hash
- `built-at`: Discord client build date timestamp
- `total-class-names`: Total class names found in theme files
- `changed-class-names`: Class names successfully updated in theme files
- `failed-changed-class-names`: Class names that could not be updated in theme files

## Data Outputs

The [data](https://github.com/fedeericodl/discord-update-classnames/tree/data) branch contains structured results from class name analysis:

**:warning: Never manually edit these files - changes will be overwritten**

- [`buildInfo.json`](https://github.com/fedeericodl/discord-update-classnames/blob/data/buildInfo.json): unique hash and the built at timestamp of last processed canary build.
- [`classNamesMap.json`](https://github.com/fedeericodl/discord-update-classnames/blob/data/classNamesMap.json): tracks and maps the old class names with the updated ones. Updates on this file occur automatically once class names hashes on that exact module ID got changed; this means, if a class name got moved to another module, it won't be updated here, due to the module ID being different ([issue](https://github.com/fedeericodl/discord-update-classnames/issues/1)).
- [`moduleClassNames.json`](https://github.com/fedeericodl/discord-update-classnames/blob/data/moduleClassNames.json): current canary build's class names organized by module ID.

## Disclaimer

**This project is not affiliated with, maintained by, or endorsed by Discord Inc.** Class names are obtained through public web resources and may change without notice. Always verify changes before merging automated PRs.

## License

This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.

discord-update-classnames

discord-update-classnames Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

discord-update-classnames

discord-update-classnames Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README