1497850 - [project.config] Find source files (en-US) through project configuration

Status: RESOLVED FIXED

(Webtools Graveyard :: Pontoon, enhancement, P2)

Description

[Matjaz Horvat [:mathjazz]]

Pontoon requires project repositories to follow a particular directory structure in order to detect files used for localization:
https://developer.mozilla.org/en-US/docs/Mozilla/Implementing_Pontoon_in_a_Mozilla_website#A._Make_your_project_localizable

We should drop that requirement by supporting project configuration files:
https://moz-l10n-config.readthedocs.io/en/latest/fileformat.html

This bug tracks the implementation of finding source files (en-US) through project configuration.

Comment 1

[GitHub Bugzilla PR Linker]

Attachment: Link to GitHub pull-request: https://github.com/mozilla/pontoon/pull/1120

Comment 2

[[github robot]]

Commit pushed to master at https://github.com/mozilla/pontoon

https://github.com/mozilla/pontoon/commit/0e48e21c6ba9f3b939f117d208e53673dd89699e
Fix bug 1497850: Enable finding source files via project config (#1120)

Pontoon finds source (AKA reference) files in two steps:

* First, it finds the source directory, which must be called templates,
  en-US, en-us, en or some other variations, and contain at least one
  file with supported file extensions.
* Then, it searches for all files with supported file extensions within
  the source directory. These files are treated as source files.

Project configuration brings more flexibility and reliability in
detecting source files by explicitly defining their paths or patterns.
This PR adds support for that, while keeping the algorithm described
above avaialble for projects that don't use the project configuration
file.

Finding source files through project configuration works like this:

* Source files could be stored in multiple directories, so we just use
  the source repository checkout directory as the source directory.
* Then, we search for all non-hidden paths within that directory that
  match one of the reference patters in the project configuration file.