Skip to content

Commit

Permalink
feat: remove auto inspect overrides (#21)
Browse files Browse the repository at this point in the history
* feat: remove auto inspect overrides

* feat: remove remaining autoinspect functions and docs

* chore: update CHANGELOG
  • Loading branch information
hpopp authored Aug 31, 2024
1 parent 07d3929 commit c1695f6
Show file tree
Hide file tree
Showing 12 changed files with 32 additions and 672 deletions.
15 changes: 0 additions & 15 deletions .travis.yml

This file was deleted.

50 changes: 32 additions & 18 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,35 @@
# Changelog

## Unreleased

- Removed `Scribe.auto_inspect/1`.
- Removed `Scribe.auto_inspect?/0`.

## v0.10.0
* Added `:device` option to `Scribe.print/2` for printing to a specific device.

- Added `:device` option to `Scribe.print/2` for printing to a specific device.
Defaults to `:stdio`

## v0.9.0
* `NoBorder` style added.

- `NoBorder` style added.

## v0.8.2
* Support for Elixir `v1.8`

- Support for Elixir `v1.8`

## v0.8.1
* Support for Elixir `v1.7`

- Support for Elixir `v1.7`

## v0.8.0
* `:compile_auto_inspect` and `:auto_inspect` config options, both default

- `:compile_auto_inspect` and `:auto_inspect` config options, both default
to `false`.
* Added `Scribe.auto_inspect/1` for toggling auto inspect.
* Added `Scribe.auto_inspect?/0`.
* Removed `Scribe.enable/0` and `Scribe.disable/0`, replaced with above.
* Removed `Scribe.enabled?/0`, replaced with above.
- Added `Scribe.auto_inspect/1` for toggling auto inspect.
- Added `Scribe.auto_inspect?/0`.
- Removed `Scribe.enable/0` and `Scribe.disable/0`, replaced with above.
- Removed `Scribe.enabled?/0`, replaced with above.

To work with production releases, auto-inspect functionality can now be
optionally compiled (not compiled by default). To enable auto-inspect for
Expand All @@ -37,20 +47,24 @@ If auto-inspect is not compiled (or disabled), `Scribe.print/2` and similar
functions will continue to work as normal.

## v0.7.0
* Pseudographics style added.

- Pseudographics style added.

## v0.6.0
* Overrides Inspect protocol for `List` and `Map`. These types will now

- Overrides Inspect protocol for `List` and `Map`. These types will now
automatically return in Scribe's table format. Disabled by default.
with `config :scribe, enable: false` in your Mix config.
* `Scribe.enable`, `Scribe.disable`, and `Scribe.enabled?` added.
* Minimum Elixir version bumped to `1.5`.
- `Scribe.enable`, `Scribe.disable`, and `Scribe.enabled?` added.
- Minimum Elixir version bumped to `1.5`.

## v0.5.1
* Bump pane dependency to v0.2.0.

- Bump pane dependency to v0.2.0.

## v0.5.0
* `@behaviour Scribe.Style` implemented (See `/style` for example adapters)
* Colorized output.
* Default styling no longer separates data rows.
* Tables no longer width-limited unless specified.

- `@behaviour Scribe.Style` implemented (See `/style` for example adapters)
- Colorized output.
- Default styling no longer separates data rows.
- Tables no longer width-limited unless specified.
21 changes: 0 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,27 +52,6 @@ iex(1)> User |> limit(5) |> Repo.all |> Scribe.print
+-------------+----------------------------+------+
```

## Use Scribe Automatically

Scribe can override `Inspect` to automatically return maps in table format.
Add the following to your `config/dev.exs`:

```elixir
config :scribe,
compile_auto_inspect: true,
auto_inspect: true
```

Temporarily disable in the shell if needed:

```elixir
iex(1)> Scribe.auto_inspect(false)
:ok
```

**Note: Auto-inspect will not work in production Distillery
releases. Leave it out of your prod.exs**

## Pagination

Scribe uses [pane](https://github.com/codedge-llc/pane) to paginate large tables.
Expand Down
30 changes: 0 additions & 30 deletions config/config.exs

This file was deleted.

5 changes: 0 additions & 5 deletions config/dev.exs

This file was deleted.

9 changes: 0 additions & 9 deletions config/dogma.exs

This file was deleted.

5 changes: 0 additions & 5 deletions config/test.exs

This file was deleted.

214 changes: 0 additions & 214 deletions inspect_overrides/1_5.ex

This file was deleted.

Loading

0 comments on commit c1695f6

Please sign in to comment.