Accent Documentation

The namePattern option in your files configuration determines how a file's name is represented in Accent. Available patterns:

• file (default): Uses the filename without the extension. Example: Localizable.strings becomes Localizable.
• fileWithSlugSuffix: Uses the filename without the extension and strips the language slug from the suffix. Example: Localizable.en.strings becomes Localizable.
• parentDirectory: Uses the name of the directory containing the file. Useful when files are named only by language.
• fileWithParentDirectory: Uses the file path in addition to the filename. The %slug% placeholder in the target path acts as the root for this path.

{
  "files": [
    {
      "namePattern": "fileWithParentDirectory",
      "source": "translations/en/**/*.json",
      "target": "translations/%slug%/%document_path%.json"
    }
  ]
}

The data flow for managing lint entries follows this pattern:

1. User Interaction: The FormModal manages local state and triggers an action (@onCreate, @onUpdate, or @onDelete) in the parent controller.
2. Mutation: The controller uses apolloMutate.mutate to call the GraphQL mutation, passing the necessary variables and specifying refetchQueries: ['ProjectLintEntries'] to ensure the list stays in sync.
3. Backend Processing: The Elixir backend processes the mutation. If the changeset is invalid, it returns successful: false and a list of error messages.
4. UI Update: Upon a successful mutation, the ProjectLintEntries query is refetched, the list re-renders, and a success flash message is displayed. If errors occur, the modal remains open and error messages are displayed.

Accent can automatically extract a version from your current Git branch name using the branchVersionPrefix setting in the version object.

If you set "branchVersionPrefix": "release/", a branch named release/v1.0.0 will cause the sync and stats commands to behave as if --version=1.0.0 was passed.

"version": {
  "branchVersionPrefix": "release/"
}

You can define shell commands to run at specific points in the Accent CLI lifecycle using the hooks key in your file configuration. Available hooks are:

• beforeSync
• afterSync
• beforeExport
• afterExport

"hooks": {
  "afterSync": ["touch sync-done.txt", "echo 'Done!'"]
}

You can run a production-like environment locally using Docker and docker-compose without installing Elixir or NodeJS. This uses an OTP release of the app.

1. Build the OTP release: make build
2. Start PostgreSQL: make dev-start-postgresql (runs on port 5432 with user postgres).
3. Start the application: make dev-start-application. The release hook will automatically execute migrations and seeds before starting the webserver on port 4000.

Install the Accent CLI globally using npm to access the accent command in your terminal.

$ npm install -g accent-cli

To verify changes to the Project Lint Entry management system, run the following commands:

Backend (Elixir):

mix format
mix credo --strict
mix compile --warnings-as-errors --force
env $(cat .env.test.local | xargs) mix test test/graphql/resolvers/lint_test.exs

Frontend (Ember/TypeScript):

cd webapp
node node_modules/.bin/tsc        # type-check
node node_modules/.bin/ember build --output-path=<tmp>   # template/component compile

When contributing to the project, follow these steps:

1. Open an issue before opening a pull request.
2. Ensure your additions pass the test suite.
3. Run the ./priv/scripts/ci-check.sh script locally to verify that the CI build will pass before submitting your PR.