Skip to content

Commit

Permalink
1.02 - First real release.
Browse files Browse the repository at this point in the history
  • Loading branch information
Timofey Potapov committed May 13, 2024
1 parent b5836d9 commit 25398c3
Show file tree
Hide file tree
Showing 8 changed files with 394 additions and 60 deletions.
8 changes: 5 additions & 3 deletions .github/workflows/build-and-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ name: build and test
on:
push:
branches:
- "main2"
- "main"
pull_request:
branches:
- "main2"
- "main"
workflow_dispatch:

jobs:
Expand All @@ -26,7 +26,6 @@ jobs:

- name: Install dependencies
run: |
apt install -y libreadline-dev
cpanm Module::Build~0.4004
cpanm Test::CheckManifest
perl Build.PL
Expand Down Expand Up @@ -84,6 +83,9 @@ jobs:
os: [ ubuntu-latest, macos-latest ]
distribution: [ default ]
perl-version:
- "5.12"
- "5.14"
- "5.16"
- "5.18"
- "5.20"
- "5.22"
Expand Down
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ build_dir/
nytprof.out
pod2htm*.tmp
pm_to_blib
Runtime-Debugger-*
Runtime-Debugger-*.tar.gz
e-*
e-*.tar.gz
*.swp
*.bak
9 changes: 8 additions & 1 deletion Build.PL
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,14 @@ my $builder = $class->new(
'Test::More' => '0',
},
requires => {
'perl' => '5.012',
'perl' => '5.012',
# 'Sub::Util' => '0',
# 'Runtime::Debugger' => '0.19',
# 'Data::Trace' => '0.19',
# 'Tiny::Prof' => '0',
# 'Mojolicious' => '0',
# 'YAML::XS' => '0',
# 'Data::Printer' => '0',
},
add_to_cleanup => [
'e-*',
Expand Down
8 changes: 6 additions & 2 deletions Changes
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
Revision history for e

0.01 Date/time
First version, released on an unsuspecting world.
====
1.02
====

2024-05-13

First real release.
2 changes: 2 additions & 0 deletions MANIFEST
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@ Build.PL
Changes
lib/e.pm
MANIFEST This list of files
MANIFEST.SKIP
META.json
META.yml
README.md
t/00-load.t
t/01-simple.t
t/manifest.t
t/pod-coverage.t
t/pod.t
77 changes: 55 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,77 @@
# NAME
# LOGO

e - The great new e!
____
___ / __/___ _____ ____ ___ ___
/ _ \ / /_/ __ \/ ___/ / __ `__ \/ _ \
/ __/ / __/ /_/ / / / / / / / / __/
\___/ /_/ \____/_/ /_/ /_/ /_/\___/

# VERSION
# NAME

Version 0.01
e - Unleash the power of e!

# SYNOPSIS

Quick summary of what the module does.
Convert a data structure to json:

perl -Me -e 'say j { a => [ 1..3] }'

Convert a data structure to yaml:

perl -Me -e 'say yml { a => [ 1..3] }'

Pretty print a data structure:

perl -Me -e 'p { a => [ 1..3] }'

Data dump a data structure:

perl -Me -e 'd { a => [ 1..3] }'

Devel::Peek dump a data structure:

Perhaps a little code snippet.
perl -Me -e 'dd { a => [ 1..3] }'

use e;
Add a trace marker:

my $foo = e->new();
...
perl -Me -e 'dd {'
perl -Me -e 'sub f1 { trace } sub f2 { f1 } f2'

# EXPORT
Watch a reference for changes:

A list of functions that can be exported. You can delete this section
if you don't export anything, such as for a purely object-oriented module.
perl -Me -e 'my $v = {}; sub f1 { watcg( $v ) } sub f2 { f1; $v->{a} = 1 } f2'

# SUBROUTINES/METHODS
Launch the Runtime::Debugger:

## function1
perl -Me -e 'repl'

## function2
Invoke the Tiny::Prof:

perl -Me -e 'prof'

# SUBROUTINES

## monkey\_patch

insert subroutines into the symbol table.

Extracted from Mojo::Util for performance.

Can be updated once this issue is resolved:
[https://github.com/mojolicious/mojo/pull/2173](https://github.com/mojolicious/mojo/pull/2173)

## import

Inserts commands into caller's namespace.

# AUTHOR

tim Potapov, `<tim.potapov[AT]gmail.com>`
Tim Potapov, `<tim.potapov[AT]gmail.com>`

# BUGS

Please report any bugs or feature requests to `bug-e at rt.cpan.org`, or through
the web interface at [https://rt.cpan.org/NoAuth/ReportBug.html?Queue=e](https://rt.cpan.org/NoAuth/ReportBug.html?Queue=e). I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.
Please report any bugs or feature requests to
[https://github.com/poti1/e/issues](https://github.com/poti1/e/issues).

# SUPPORT

Expand All @@ -51,11 +86,9 @@ You can also look for information at:

[https://github.com/poti1/e](https://github.com/poti1/e)

# ACKNOWLEDGEMENTS

# LICENSE AND COPYRIGHT

This software is Copyright (c) 2024 by tim Potapov.
This software is Copyright (c) 2024 by Tim Potapov.

This is free software, licensed under:

Expand Down
Loading

0 comments on commit 25398c3

Please sign in to comment.