Skip to content

The application will index a source directory and compare the index against one or more target directories. Based on whether link map configuration exists for the node or not, the node will either be linked or printed as unlinked source node.

License

Notifications You must be signed in to change notification settings

raatiniemi/linker

Repository files navigation

linker

license pipeline status coverage report

The application will index a source directory and compare the index against one or more target directories. Based on whether link map configuration exists for the node or not, the node will either be linked or printed as unlinked source node.

Example

/source/directory-1
/source/directory-2
/source/directory-3
/target/directory-1 -> /source/directory-1
/target/directory-3 -> /source/directory-2

With the sample directory structure only the /source/directory-3 will be shown as unlinked. Note that the application works with the basename of the source of the symbolic link, i.e. the linked name do not really matters.

How to

In order to build the application run cargo build --release, this will produce binaries located within the ./target/release directory.

cli

The cli application accepts a couple of arguments, use the -h option to view help information.

Sample configuration file:

{
    "source": "/path/to/source-directory",
    "targets": [
        "/path/to/target-directory-1",
        "/path/to/target-directory-2"
    ],
    "excludes": [
        "exclude1",
        "exclude2"
    ],
    "linkMaps": [
        {
            "regex": "^(?i)(target[-]item[-]1)",
            "target": "/path/to/target-directory-1"
        }
    ]
}

LinkMaps

To enable automatic linking, i.e. the application creates symbolic links based on a regular expression.

Each configuration item must supply a regex and target.

  • regex matches a basename.
  • target is the location to which the link will be created.

The sample configuration will link matching items with the equivalent ln-command:

ln -s ../source-directory/target-item-1 /path/to/target-directory-1/target-item-1

License

linker
Copyright (C) 2021 raatiniemi

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, version 2 of the License.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

About

The application will index a source directory and compare the index against one or more target directories. Based on whether link map configuration exists for the node or not, the node will either be linked or printed as unlinked source node.

Topics

Resources

License

Stars

Watchers

Forks