@aloth/olcli 0.1.8 → 0.3.0

package/dist/ignore.d.ts

@@ -0,0 +1,85 @@
+/**
+ * olcli ignore subsystem
+ *
+ * Layered defense against syncing local LaTeX build artifacts (and other
+ * unwanted files) up to Overleaf:
+ *
+ *   1. Built-in ignore list  — always on, opt out with --no-default-ignore
+ *   2. .olignore             — project-level, gitignore-style syntax
+ *   3. .olignore.local       — machine-specific, never synced (gitignore'd)
+ *
+ * Special PDF rule: ignore `X.pdf` only if a same-named `X.tex` (or `.ltx`)
+ * exists in the same folder. This kills `thesis.pdf` next to `thesis.tex`
+ * but preserves a hand-uploaded `figures/diagram.pdf`.
+ *
+ * Escape hatches:
+ *   --no-default-ignore  → only .olignore + .olignore.local apply
+ *   --no-ignore          → no filtering at all
+ *
+ * See issue #19 for design rationale.
+ */
+import { Ignore } from 'ignore';
+/**
+ * Default ignore patterns, applied unless --no-default-ignore is set.
+ *
+ * Covers LaTeX build artifacts (pdflatex / xelatex / lualatex / latexmk /
+ * biber / makeindex / glossaries / minted), common editor noise, and
+ * conventional build directories.
+ *
+ * Note: `*.pdf` is NOT in this list — see shouldIgnore() for the special
+ * sibling-`.tex` rule.
+ */
+export declare const DEFAULT_IGNORE_PATTERNS: readonly string[];
+/**
+ * Resolved ignore configuration for a project directory.
+ */
+export interface IgnoreContext {
+    /** All effective patterns in priority order (later overrides earlier). */
+    patterns: string[];
+    /** Sources contributing to `patterns`, for `olcli ignored` output. */
+    sources: Array<{
+        label: string;
+        patterns: string[];
+    }>;
+    /** True when defaults are enabled. */
+    defaultsEnabled: boolean;
+    /** True when ignore filtering is enabled at all. */
+    enabled: boolean;
+    /** Compiled matcher; null when `enabled === false`. */
+    matcher: Ignore | null;
+}
+export interface LoadIgnoreOptions {
+    /** Disable the built-in DEFAULT_IGNORE_PATTERNS list. */
+    noDefaults?: boolean;
+    /** Disable all ignore filtering entirely (overrides everything else). */
+    disableAll?: boolean;
+}
+/**
+ * Build an IgnoreContext for the given project root.
+ *
+ * Layering (lowest → highest precedence; `ignore` semantics: later wins):
+ *   1. DEFAULT_IGNORE_PATTERNS   (unless noDefaults)
+ *   2. <root>/.olignore          (project, version-controlled)
+ *   3. <root>/.olignore.local    (machine-only, gitignore'd)
+ */
+export declare function loadIgnore(root: string, opts?: LoadIgnoreOptions): IgnoreContext;
+/**
+ * Decide whether a given relative path should be ignored.
+ *
+ * @param relativePath  Path relative to the project root, forward-slash.
+ *                      For directories, callers may pass `dir/` (trailing
+ *                      slash) to engage gitignore directory matching.
+ * @param ctx           From `loadIgnore`.
+ * @param siblingTexBaseNames  Set of file basenames (without extension) in
+ *                      the same folder as `relativePath` that have a `.tex`
+ *                      or `.ltx` source. Used for the PDF special rule.
+ *                      Pass `undefined` to skip the PDF rule.
+ */
+export declare function shouldIgnore(relativePath: string, ctx: IgnoreContext, siblingTexBaseNames?: Set<string>): boolean;
+/**
+ * Convenience: build a per-folder set of basenames that have a `.tex` or
+ * `.ltx` companion. Caller passes the list of files in that folder (just
+ * basenames, not full paths).
+ */
+export declare function buildTexSiblingSet(folderFileNames: Iterable<string>): Set<string>;
+//# sourceMappingURL=ignore.d.ts.map

package/dist/ignore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ignore.d.ts","sourceRoot":"","sources":["../src/ignore.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAIH,OAAe,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAExC;;;;;;;;;GASG;AACH,eAAO,MAAM,uBAAuB,EAAE,SAAS,MAAM,EA6BnD,CAAC;AAEH;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,0EAA0E;IAC1E,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,sEAAsE;IACtE,OAAO,EAAE,KAAK,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,MAAM,EAAE,CAAC;KACpB,CAAC,CAAC;IACH,sCAAsC;IACtC,eAAe,EAAE,OAAO,CAAC;IACzB,oDAAoD;IACpD,OAAO,EAAE,OAAO,CAAC;IACjB,uDAAuD;IACvD,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC,yDAAyD;IACzD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,yEAAyE;IACzE,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAmBD;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,iBAAsB,GAAG,aAAa,CAwCpF;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAC1B,YAAY,EAAE,MAAM,EACpB,GAAG,EAAE,aAAa,EAClB,mBAAmB,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,GAChC,OAAO,CAuBT;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,eAAe,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,CAOjF"}

package/dist/ignore.js

@@ -0,0 +1,172 @@
+/**
+ * olcli ignore subsystem
+ *
+ * Layered defense against syncing local LaTeX build artifacts (and other
+ * unwanted files) up to Overleaf:
+ *
+ *   1. Built-in ignore list  — always on, opt out with --no-default-ignore
+ *   2. .olignore             — project-level, gitignore-style syntax
+ *   3. .olignore.local       — machine-specific, never synced (gitignore'd)
+ *
+ * Special PDF rule: ignore `X.pdf` only if a same-named `X.tex` (or `.ltx`)
+ * exists in the same folder. This kills `thesis.pdf` next to `thesis.tex`
+ * but preserves a hand-uploaded `figures/diagram.pdf`.
+ *
+ * Escape hatches:
+ *   --no-default-ignore  → only .olignore + .olignore.local apply
+ *   --no-ignore          → no filtering at all
+ *
+ * See issue #19 for design rationale.
+ */
+import { readFileSync, existsSync } from 'node:fs';
+import { join, basename } from 'node:path';
+import ignore from 'ignore';
+/**
+ * Default ignore patterns, applied unless --no-default-ignore is set.
+ *
+ * Covers LaTeX build artifacts (pdflatex / xelatex / lualatex / latexmk /
+ * biber / makeindex / glossaries / minted), common editor noise, and
+ * conventional build directories.
+ *
+ * Note: `*.pdf` is NOT in this list — see shouldIgnore() for the special
+ * sibling-`.tex` rule.
+ */
+export const DEFAULT_IGNORE_PATTERNS = Object.freeze([
+    // ─── LaTeX core build artifacts ───────────────────────────────────────
+    '*.aux', '*.bbl', '*.blg', '*.log', '*.out', '*.toc',
+    '*.lof', '*.lot',
+    // latexmk
+    '*.fls', '*.fdb_latexmk',
+    // synctex
+    '*.synctex.gz', '*.synctex',
+    // Beamer
+    '*.nav', '*.snm', '*.vrb',
+    // makeindex
+    '*.idx', '*.ind', '*.ilg',
+    // glossaries
+    '*.glo', '*.gls', '*.glg', '*.acn', '*.acr', '*.alg',
+    '*.ist', '*.xdy',
+    // biber / biblatex
+    '*.bcf', '*.run.xml',
+    // xelatex / dvi
+    '*.xdv', '*.dvi',
+    // pdflatex aux variants
+    '*.pyg', // minted pygments cache leftover
+    // ─── Build directories ────────────────────────────────────────────────
+    '_minted-*/',
+    'build/', 'out/', 'dist/',
+    // ─── Editor / OS noise ────────────────────────────────────────────────
+    '.DS_Store', 'Thumbs.db', 'desktop.ini',
+    '*.swp', '*.swo', '*~', '*.bak',
+    // ─── Overleaf-specific reserved ───────────────────────────────────────
+    'output.pdf', // Overleaf compile output convention
+]);
+/**
+ * Read patterns from a .olignore-style file. Returns [] if missing.
+ * Comments (# …) and blank lines are stripped by the `ignore` package
+ * itself; we just split on newlines.
+ */
+function readIgnoreFile(path) {
+    if (!existsSync(path))
+        return [];
+    try {
+        return readFileSync(path, 'utf-8')
+            .split(/\r?\n/)
+            .map((line) => line.replace(/\s+$/, ''))
+            .filter((line) => line.length > 0 && !line.startsWith('#'));
+    }
+    catch {
+        return [];
+    }
+}
+/**
+ * Build an IgnoreContext for the given project root.
+ *
+ * Layering (lowest → highest precedence; `ignore` semantics: later wins):
+ *   1. DEFAULT_IGNORE_PATTERNS   (unless noDefaults)
+ *   2. <root>/.olignore          (project, version-controlled)
+ *   3. <root>/.olignore.local    (machine-only, gitignore'd)
+ */
+export function loadIgnore(root, opts = {}) {
+    if (opts.disableAll) {
+        return {
+            patterns: [],
+            sources: [],
+            defaultsEnabled: false,
+            enabled: false,
+            matcher: null,
+        };
+    }
+    const sources = [];
+    if (!opts.noDefaults) {
+        sources.push({
+            label: 'built-in defaults',
+            patterns: [...DEFAULT_IGNORE_PATTERNS],
+        });
+    }
+    const projectIgnore = readIgnoreFile(join(root, '.olignore'));
+    if (projectIgnore.length > 0) {
+        sources.push({ label: '.olignore', patterns: projectIgnore });
+    }
+    const localIgnore = readIgnoreFile(join(root, '.olignore.local'));
+    if (localIgnore.length > 0) {
+        sources.push({ label: '.olignore.local', patterns: localIgnore });
+    }
+    const patterns = sources.flatMap((s) => s.patterns);
+    const matcher = ignore().add(patterns);
+    return {
+        patterns,
+        sources,
+        defaultsEnabled: !opts.noDefaults,
+        enabled: true,
+        matcher,
+    };
+}
+/**
+ * Decide whether a given relative path should be ignored.
+ *
+ * @param relativePath  Path relative to the project root, forward-slash.
+ *                      For directories, callers may pass `dir/` (trailing
+ *                      slash) to engage gitignore directory matching.
+ * @param ctx           From `loadIgnore`.
+ * @param siblingTexBaseNames  Set of file basenames (without extension) in
+ *                      the same folder as `relativePath` that have a `.tex`
+ *                      or `.ltx` source. Used for the PDF special rule.
+ *                      Pass `undefined` to skip the PDF rule.
+ */
+export function shouldIgnore(relativePath, ctx, siblingTexBaseNames) {
+    if (!ctx.enabled || !ctx.matcher)
+        return false;
+    // The `ignore` package requires forward slashes and rejects leading `/`.
+    const normalized = relativePath.replace(/\\/g, '/').replace(/^\/+/, '');
+    if (normalized === '' || normalized === '.')
+        return false;
+    if (ctx.matcher.ignores(normalized))
+        return true;
+    // Special PDF rule (only when defaults active — it's a default-list policy):
+    // ignore `X.pdf` if a sibling `X.tex` (or .ltx) exists.
+    if (ctx.defaultsEnabled &&
+        siblingTexBaseNames &&
+        /\.pdf$/i.test(normalized)) {
+        const base = basename(normalized).replace(/\.pdf$/i, '');
+        if (siblingTexBaseNames.has(base.toLowerCase())) {
+            return true;
+        }
+    }
+    return false;
+}
+/**
+ * Convenience: build a per-folder set of basenames that have a `.tex` or
+ * `.ltx` companion. Caller passes the list of files in that folder (just
+ * basenames, not full paths).
+ */
+export function buildTexSiblingSet(folderFileNames) {
+    const out = new Set();
+    for (const name of folderFileNames) {
+        const m = name.match(/^(.+)\.(tex|ltx)$/i);
+        if (m)
+            out.add(m[1].toLowerCase());
+    }
+    return out;
+}
+//# sourceMappingURL=ignore.js.map

package/dist/ignore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ignore.js","sourceRoot":"","sources":["../src/ignore.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,IAAI,EAAW,QAAQ,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,MAAkB,MAAM,QAAQ,CAAC;AAExC;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAsB,MAAM,CAAC,MAAM,CAAC;IACtE,yEAAyE;IACzE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO;IACpD,OAAO,EAAE,OAAO;IAChB,UAAU;IACV,OAAO,EAAE,eAAe;IACxB,UAAU;IACV,cAAc,EAAE,WAAW;IAC3B,SAAS;IACT,OAAO,EAAE,OAAO,EAAE,OAAO;IACzB,YAAY;IACZ,OAAO,EAAE,OAAO,EAAE,OAAO;IACzB,aAAa;IACb,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO;IACpD,OAAO,EAAE,OAAO;IAChB,mBAAmB;IACnB,OAAO,EAAE,WAAW;IACpB,gBAAgB;IAChB,OAAO,EAAE,OAAO;IAChB,wBAAwB;IACxB,OAAO,EAAwB,iCAAiC;IAChE,yEAAyE;IACzE,YAAY;IACZ,QAAQ,EAAE,MAAM,EAAE,OAAO;IACzB,yEAAyE;IACzE,WAAW,EAAE,WAAW,EAAE,aAAa;IACvC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO;IAC/B,yEAAyE;IACzE,YAAY,EAAmB,qCAAqC;CACrE,CAAC,CAAC;AA4BH;;;;GAIG;AACH,SAAS,cAAc,CAAC,IAAY;IAClC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,OAAO,EAAE,CAAC;IACjC,IAAI,CAAC;QACH,OAAO,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC;aAC/B,KAAK,CAAC,OAAO,CAAC;aACd,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;aACvC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IAChE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,UAAU,CAAC,IAAY,EAAE,OAA0B,EAAE;IACnE,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;QACpB,OAAO;YACL,QAAQ,EAAE,EAAE;YACZ,OAAO,EAAE,EAAE;YACX,eAAe,EAAE,KAAK;YACtB,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAA6B,EAAE,CAAC;IAE7C,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,mBAAmB;YAC1B,QAAQ,EAAE,CAAC,GAAG,uBAAuB,CAAC;SACvC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,aAAa,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;IAC9D,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,CAAC;IAChE,CAAC;IAED,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAClE,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,iBAAiB,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IACpD,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAEvC,OAAO;QACL,QAAQ;QACR,OAAO;QACP,eAAe,EAAE,CAAC,IAAI,CAAC,UAAU;QACjC,OAAO,EAAE,IAAI;QACb,OAAO;KACR,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,YAAY,CAC1B,YAAoB,EACpB,GAAkB,EAClB,mBAAiC;IAEjC,IAAI,CAAC,GAAG,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO;QAAE,OAAO,KAAK,CAAC;IAE/C,yEAAyE;IACzE,MAAM,UAAU,GAAG,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACxE,IAAI,UAAU,KAAK,EAAE,IAAI,UAAU,KAAK,GAAG;QAAE,OAAO,KAAK,CAAC;IAE1D,IAAI,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC;QAAE,OAAO,IAAI,CAAC;IAEjD,6EAA6E;IAC7E,wDAAwD;IACxD,IACE,GAAG,CAAC,eAAe;QACnB,mBAAmB;QACnB,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,EAC1B,CAAC;QACD,MAAM,IAAI,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QACzD,IAAI,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;YAChD,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,eAAiC;IAClE,MAAM,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;IAC9B,KAAK,MAAM,IAAI,IAAI,eAAe,EAAE,CAAC;QACnC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAC3C,IAAI,CAAC;YAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IACrC,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aloth/olcli",
-  "version": "0.1.8",
+  "version": "0.3.0",
   "description": "Command-line interface for Overleaf — Sync, manage, and compile LaTeX projects from your terminal",
   "type": "module",
   "bin": {
@@ -49,6 +49,7 @@
     "cheerio": "^1.0.0",
     "commander": "^12.1.0",
     "conf": "^13.0.0",
+    "ignore": "^7.0.5",
     "ora": "^8.0.1",
     "tough-cookie": "^4.1.4"
   },