### Setup Project with Git, PNPM

Source: https://github.com/profullstack/text-type-detection/blob/master/README.md

Clones the project repository, navigates into the directory, and installs project dependencies using PNPM. Assumes Git and PNPM are already installed.

```bash
# Clone the repository
git clone https://github.com/profullstack/text-type-detection.git
cd text-type-detection

# Install dependencies
pnpm install
```

--------------------------------

### Install @profullstack/text-type-detection with pnpm

Source: https://github.com/profullstack/text-type-detection/blob/master/README.md

This command installs the @profullstack/text-type-detection package using the pnpm package manager. It is a direct dependency for the project.

```bash
pnpm add @profullstack/text-type-detection
```

--------------------------------

### Install @profullstack/text-type-detection with npm

Source: https://github.com/profullstack/text-type-detection/blob/master/README.md

This command installs the @profullstack/text-type-detection package using the npm package manager. It is a direct dependency for the project.

```bash
npm install @profullstack/text-type-detection
```

--------------------------------

### Run Project Tests with PNPM

Source: https://github.com/profullstack/text-type-detection/blob/master/README.md

Executes the project's test suite using PNPM. Includes options to run all tests or run tests in watch mode for continuous feedback during development.

```bash
# Run all tests
pnpm test

# Run tests in watch mode
pnpm run test:watch
```

--------------------------------

### Basic Text Format Detection in JavaScript

Source: https://github.com/profullstack/text-type-detection/blob/master/README.md

Demonstrates the basic usage of the `detectTextFormat` function from the `@profullstack/text-type-detection` module. It takes a string as input and returns an object containing the detected text format and associated statistics.

```javascript
import { detectTextFormat } from '@profullstack/text-type-detection';

const text = '# Hello World\n\nThis is a markdown document.';
const result = detectTextFormat(text);

console.log(result);
// {\n//   text_format: 'markdown',\n//   asciiArt: 0.000,\n//   markdown: 0.180,\n//   reasons: {\n//     ascii: [],\n//     markdown: ['heading'],\n//     codePenaltyApplied: false\n//   },\n//   stats: { lines: 3, mean: 20.67, std: 12.34, symD: 0.05, alpha: 0.75 }\n// }
```

--------------------------------

### Lint and Format Code with PNPM

Source: https://github.com/profullstack/text-type-detection/blob/master/README.md

Manages code quality and consistency using PNPM commands for ESLint and Prettier. Allows running linters and formatters, including an option to automatically fix linting issues.

```bash
# Run ESLint
pnpm run lint

# Fix linting issues
pnpm run lint:fix

# Format code with Prettier
pnpm run format
```

--------------------------------

### Detecting Plain Text Format in JavaScript

Source: https://github.com/profullstack/text-type-detection/blob/master/README.md

Illustrates how to use the `detectTextFormat` function to identify plain text. The function analyzes the input string and returns 'plain' as the `text_format` if no other specific format is detected.

```javascript
const plainText = 'This is just a simple sentence.';
const result = detectTextFormat(plainText);
console.log(result.text_format); // 'plain'
```

--------------------------------

### Detecting Markdown Format in JavaScript

Source: https://github.com/profullstack/text-type-detection/blob/master/README.md

Shows how to detect markdown formatted text using the `detectTextFormat` function. The output includes the detected format ('markdown') and specific markdown features found, such as headings, lists, and links.

```javascript
const markdown = `# Title\n\n## Subtitle\n\n- Item 1\n- Item 2\n\n[Link](https://example.com)`;

const result = detectTextFormat(markdown);
console.log(result.text_format); // 'markdown'
console.log(result.reasons.markdown); // ['heading', 'list', 'link']
```

--------------------------------

### Detecting JSON Format in JavaScript

Source: https://github.com/profullstack/text-type-detection/blob/master/README.md

Demonstrates the detection of JSON formatted data. The `detectTextFormat` function correctly parses and identifies the string containing JSON key-value pairs as 'json'.

```javascript
const json = '{"name": "John", "age": 30}';
const result = detectTextFormat(json);
console.log(result.text_format); // 'json'
```

--------------------------------

### Detecting HTML Format in JavaScript

Source: https://github.com/profullstack/text-type-detection/blob/master/README.md

Shows how the `detectTextFormat` function identifies standard HTML markup. The input string containing HTML tags is correctly classified as 'html'.

```javascript
const html = '<div class="container"><p>Hello World</p></div>';
const result = detectTextFormat(html);
console.log(result.text_format); // 'html'
```

--------------------------------

### Detecting XML Format in JavaScript

Source: https://github.com/profullstack/text-type-detection/blob/master/README.md

Illustrates the detection of XML formatted data. The `detectTextFormat` function recognizes the input string containing XML elements and the XML declaration as 'xml'.

```javascript
const xml = '<?xml version="1.0"?><root><item>test</item></root>';
const result = detectTextFormat(xml);
console.log(result.text_format); // 'xml'
```

--------------------------------

### Text Type Detection API

Source: https://github.com/profullstack/text-type-detection/blob/master/README.md

This section details the primary function for detecting text formats.

```APIDOC
## `detectTextFormat(text: string): DetectionResult`

### Description
Analyzes the input text and returns a detection result object.

### Method
`detectTextFormat`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- `text` (string) - Required - The text to analyze.

### Returns
An object with the following properties:
- `text_format` (string) - The detected format type. Possible values: `'plain'`, `'markdown'`, `'ascii'`, `'code'`, `'html'`, `'json'`, `'xml'`.
- `asciiArt` (number) - ASCII art confidence score (0.000 - 1.000).
- `markdown` (number) - Markdown confidence score (0.000 - 1.000).
- `reasons` (object) - Detailed detection reasons.
  - `ascii` (array) - List of ASCII art indicators found.
  - `markdown` (array) - List of markdown features found.
  - `codePenaltyApplied` (boolean) - Whether code penalty was applied.
- `stats` (object) - Statistical analysis of the text.
  - `lines` (number) - Number of lines.
  - `mean` (number) - Mean line length.
  - `std` (number) - Standard deviation of line lengths.
  - `symD` (number) - Symbol density ratio.
  - `alpha` (number) - Alphanumeric character ratio.

### Request Example
```javascript
{
  "text": "# Hello World\n\nThis is a markdown document."
}
```

### Response Example
```json
{
  "text_format": "markdown",
  "asciiArt": 0.000,
  "markdown": 0.180,
  "reasons": {
    "ascii": [],
    "markdown": ["heading"],
    "codePenaltyApplied": false
  },
  "stats": {
    "lines": 3,
    "mean": 20.67,
    "std": 12.34,
    "symD": 0.05,
    "alpha": 0.75
  }
}
```
```

--------------------------------

### Detecting Code Block Format in JavaScript

Source: https://github.com/profullstack/text-type-detection/blob/master/README.md

Illustrates the detection of a fenced code block in JavaScript. The `detectTextFormat` function identifies the triple-backtick delimited content as a 'code' format.

```javascript
const code = ````javascript
function hello() {
  console.log("Hello");
}
````;

const result = detectTextFormat(code);
console.log(result.text_format); // 'code'
```

--------------------------------

### Detecting ASCII Art Format in JavaScript

Source: https://github.com/profullstack/text-type-detection/blob/master/README.md

Demonstrates the detection of ASCII art. The `detectTextFormat` function analyzes the input string, which contains box-drawing characters, and returns 'ascii' as the `text_format` along with a confidence score.

```javascript
const asciiArt = `┌─────────────┐\n│   Hello     │\n│   World     │\n└─────────────┘`;

const result = detectTextFormat(asciiArt);
console.log(result.text_format); // 'ascii'
console.log(result.asciiArt); // 0.680 (high score)
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.