/ 
Symlink-DSL-0.4.0
River stage zero No dependents
/ Symlink::DSL

NAME

Symlink::DSL - a domain-specific language for setting up symbolic links.

VERSION

version 0.4.0

SYNOPSIS

use Symlink::DSL;

my $dir = "$ENV{HOME}/conf/trunk/shlomif-settings/home-bin-executables";
my $skip_re = undef;
my $processor = Symlink::DSL->new( { dir => $dir, skip_re => $skip_re, } );
$processor->process_manifest;

And in setup.symlinks.manifest.txt:

symlink from ~/bin/80_chars_ruler to ./bin/80_chars_ruler
symlink from ~/bin/SPECS-only-for-deps-co to ./bin/SPECS-only-for-deps-co
symlink from ~/bin/backup-slash.bash to ./bin/backup-slash.bash
symlink from ~/bin/commify to ./bin/commify
symlink from ~/bin/desktop-finish-cue to ./bin/desktop-finish-cue
symlink from ~/bin/git-com to ./bin/git-com
symlink from ~/bin/git-mkdir to ./bin/git-mkdir
symlink from ~/bin/git-s to ./bin/git-s
symlink from ~/bin/mplayer-shuffle to ./bin/mplayer-shuffle
symlink from ~/bin/sus to ./bin/sus
symlink from ~/bin/tail-extract to ./bin/tail-extract

DESCRIPTION

Symlink::DSL implements a domain-specific language for setting up symbolic links (e.g: to dot files and other resources). For example, one can write:

symlink from ~/bin/80_chars_ruler to ./bin/80_chars_ruler
symlink from ~/bin/backup-slash.bash to ./bin/backup-slash.bash

METHODS

Symlink::DSL->new({dir => $path2dir, skip_re=> $regexp})

Returns a new object.

Accepts:

  • dir

    The directory path which contains the manifest file.

  • skip_re

    A regular expression that will skip checking existing links.

  • manifest_base

    The basename of the manifest file. Defaults to setup.symlinks.manifest.txt . (Added in 0.2.0).

$obj->dir()

Returns the directory path.

$obj->handle_line({line => $line_string})

Handles a single line.

$obj->manifest_base()

Returns the basename of the manifest files. Can be set in new() .

(Added in 0.2.0 .)

$obj->manifest()

Returns the manifest path.

$obj->manifest_exists()

Returns whether the manifest exists.

$obj->process_manifest()

Processes all lines in the manifest file.

$obj->process_single_record({from=>$dest, line=>$l, to=>$src,})

Processes a single record / a single operation.

( Added in v0.4.0 . )

$obj->skip_re()

Returns the optional regex to skip dest paths.

SEE ALSO

GNU Stow which seems more limited and is under the GPL.

Setup .

Doit .

SUPPORT

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

Bugs / Feature Requests

Please report any bugs or feature requests by email to bug-symlink-dsl at rt.cpan.org, or through the web interface at https://rt.cpan.org/Public/Bug/Report.html?Queue=Symlink-DSL. You will be automatically notified of any progress on the request by the system.

Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

https://github.com/shlomif/Symlink-DSL

git clone https://github.com/shlomif/Symlink-DSL.git

AUTHOR

Shlomi Fish <shlomif@cpan.org>

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/shlomif/symlink-dsl/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

COPYRIGHT AND LICENSE

This software is Copyright (c) 2019 by Shlomi Fish.

This is free software, licensed under:

The MIT (X11) License