3.2.0 • Published 12 months ago

scss-sassdoc-parser v3.2.0

Weekly downloads
-
License
MIT
Repository
github
Last release
12 months ago

scss-sassdoc-parser

A lightweight parser for SassDoc.

Usage

import { parse } from "scss-sassdoc-parser";

async function doParse() {
  const result = await parse(`
/// Keeps it secret
/// @output Sets display to hidden
@mixin _keep-it-secret {
  display: hidden;
}
`);

doParse();

Or sync

import { parseSync } from "scss-sassdoc-parser";

const result = parseSync(`
/// Keeps it secret
/// @output Sets display to hidden
@mixin _keep-it-secret {
  display: hidden;
}
`);

Parse using paths

import fs from "node:fs/promises";
import { parse } from "scss-sassdoc-parser";

export async function doParse(path: string | string[]): Promise<ParseResult[]> {
	const paths = Array.isArray(path) ? path : [path];
	const result = await Promise.all(
		paths.map(async (src) => {
			const code = await fs.readFile(src, "utf-8");
			return await parse(code);
		}),
	);
	return result.flat();
}

const singlePathResult = await doParse("_helpers.scss");
const arrayOfPathsResult = await doParse(["_mixins.scss", "_functions.scss"]);

Indented syntax

The parser can handle indented syntax with a caveat:

  • The context field will not include accurate code or line fields.
import { parseSync } from "scss-sassdoc-parser";

const result = parseSync(
	`
/// Converts a value to the given unit
/// @param {Number} $value - Value to add unit to
/// @param {String} $unit - String representation of the unit
/// @return {Number} - $value expressed in $unit
@function to-length($value, $unit)
	$units: (
		"px": 1px,
		"rem": 1rem,
		"%": 1%,
		"em": 1em,
	)

	@if not index(map-keys($units), $unit)
			$_: log("Invalid unit #{$unit}.")

	@return $value * map.get($units, $unit)
`,
);

Output

The result from the parse function is an array of ParseResult (type definitions). Check out the snapshot for some example outputs:

3.2.0

12 months ago

3.1.0

1 year ago

3.0.1

1 year ago

3.0.0

1 year ago

1.0.5

2 years ago

2.0.0

2 years ago

1.0.4

3 years ago

1.0.2

3 years ago

1.0.3

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago