Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/brianary/detextive

Investigates data to determine what the textual characteristics are.
https://github.com/brianary/detextive

editorconfig encoding fsharp indentation powershell powershell-module text

Last synced: 28 days ago
JSON representation

Investigates data to determine what the textual characteristics are.

Awesome Lists containing this project

README 

        
Detextive

=========



Detextive icon



[![PowerShell Gallery Version](https://img.shields.io/powershellgallery/v/Detextive)](https://www.powershellgallery.com/packages/Detextive/)

[![PowerShell Gallery](https://img.shields.io/powershellgallery/dt/Detextive)](https://www.powershellgallery.com/packages/Detextive/)

[![Actions Status](https://github.com/brianary/Detextive/workflows/.NET%20Core/badge.svg)](https://github.com/brianary/Detextive/actions)



Investigates data to determine what the textual characteristics are.



The [ratios][] are still fairly arbirtrary, and will need more sample/test data to mature.

In addition, it may skew anglocentric in assuming primarily US-ASCII characters when

determining encoding based on byte value frequency.



To install: `Install-Module Detextive`



![example usage of Detextive](Detextive.gif)



Using the [editorconfig library][] to support [editorconfig][] settings.



[ratios]: src/Detextive/Ratio.fs "Constants used for ratios in byte value data analysis."

[editorconfig library]: https://github.com/editorconfig/editorconfig-core-net "EditorConfig Core library and command line utility written in C# for .NET/Mono http://editorconfig.org"

[editorconfig]: https://editorconfig.org/ "EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs."



Cmdlets

-------



Documentation is automatically generated using [platyPS](https://github.com/PowerShell/platyPS) (`.\doc.cmd`).



- [Add-Utf8Signature](docs/Add-Utf8Signature.md) — Adds the utf-8 signature (BOM) to a file.

- [Get-FileContentsInfo](docs/Get-FileContentsInfo.md) — Returns whether the file is binary or text, and what encoding, line endings, and indents text files contain.

- [Get-FileEditorConfig](docs/Get-FileEditorConfig.md) — Looks up the editorconfig values set for a file.

- [Get-FileEncoding](docs/Get-FileEncoding.md) — Returns the detected encoding of a file.

- [Get-FileIndents](docs/Get-FileIndents.md) — Returns details about a file's indentation characters.

- [Get-FileLineEndings](docs/Get-FileLineEndings.md) — Returns details about a file's line endings.

- [Remove-Utf8Signature](docs/Remove-Utf8Signature.md) — Removes the utf-8 signature (BOM) from a file.

- [Repair-Encoding](docs/Repair-Encoding.md) — Re-encodes commonly mis-encoded text.

- [Repair-FileEditorConfig](docs/Repair-FileEditorConfig.md) — Corrects a file's editorconfig settings when they differ from the actual formatting found.

- [Test-BinaryFile](docs/Test-BinaryFile.md) — Returns true if a file does not appear to contain parseable text, and presumably contains binary data.

- [Test-BrokenEncoding](docs/Test-BrokenEncoding.md) — Returns true if text contains a nonsense sequence of characters resulting from parsing text with the wrong encoding.

- [Test-FileEditorConfig](docs/Test-FileEditorConfig.md) — Validates a file's editorconfig settings against the actual formatting found.

- [Test-FinalNewline](docs/Test-FinalNewline.md) — Returns true if a file ends with a newline as required by the POSIX standard for text files.

- [Test-TextFile](docs/Test-TextFile.md) — Returns true if a file contains text.

- [Test-Utf8Encoding](docs/Test-Utf8Encoding.md) — Returns true if a file is parseable as UTF-8.

- [Test-Utf8Signature](docs/Test-Utf8Signature.md) — Returns true if a file starts with the optional UTF-8 BOM/signature.



Tests

-----



Tests are written for [Pester](https://github.com/Pester/Pester) (`.\test.cmd`).