Skip to content

More UI... #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
martindurant merged 6 commits into from
Jun 12, 2026
Merged

More UI... #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6b95cbe
File info
martindurant Jun 12, 2026
a20acac
Allow glob/multifile scan
martindurant Jun 12, 2026
d4fb8da
Update all UIs
martindurant Jun 12, 2026
2fcce0d
VCS info
martindurant Jun 12, 2026
b7899b3
Add missing files
martindurant Jun 12, 2026
bd9160a
cov
martindurant Jun 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions docs/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,9 @@ User Classes
proj.documentation.MkDocs
proj.documentation.RTD
proj.documentation.Sphinx
proj.git.GitRepo
proj.vcs.GitRepo
proj.vcs.HgRepo
proj.vcs.FossilRepo
proj.golang.Golang
proj.helm.HelmChart
proj.hf.HuggingFaceDataset
Expand Down Expand Up @@ -148,7 +150,9 @@ User Classes
.. autoclass:: projspec.proj.documentation.MkDocs
.. autoclass:: projspec.proj.documentation.RTD
.. autoclass:: projspec.proj.documentation.Sphinx
.. autoclass:: projspec.proj.git.GitRepo
.. autoclass:: projspec.proj.vcs.GitRepo
.. autoclass:: projspec.proj.vcs.HgRepo
.. autoclass:: projspec.proj.vcs.FossilRepo
.. autoclass:: projspec.proj.golang.Golang
.. autoclass:: projspec.proj.helm.HelmChart
.. autoclass:: projspec.proj.hf.HuggingFaceDataset
Expand Down Expand Up @@ -214,6 +218,7 @@ User Classes
~~~~~~~~~~~~

.. autosummary::
content.vcs.VCSInfo
content.cicd.CIWorkflow
content.cicd.PipelineStage
content.cicd.ServiceDependency
Expand All @@ -229,6 +234,8 @@ User Classes
content.package.PythonPackage
content.package.RustModule

.. autoclass:: projspec.content.vcs.VCSInfo
:members:
.. autoclass:: projspec.content.cicd.CIWorkflow
.. autoclass:: projspec.content.cicd.PipelineStage
.. autoclass:: projspec.content.cicd.ServiceDependency
Expand Down
173 changes: 171 additions & 2 deletions pycharm_plugin/src/main/kotlin/com/projspec/toolwindow/HtmlContent.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,13 @@ object HtmlContent {
<div id="app">
<div id="library">
<div class="toolbar">
<button id="btn-add">&#x2795; Add</button>
<div class="add-group">
<button id="btn-add">&#x2795; Add</button><button id="btn-add-chevron" title="More add options">&#9660;</button>
<div id="add-dropdown" class="add-dropdown hidden">
<div class="menu-item" id="add-local">&#128194; Local browser</div>
<div class="menu-item" id="add-advanced">&#9881;&#65039; Advanced&#8230;</div>
</div>
</div>
<button id="btn-reload">&#x1F504; Reload</button>
<button id="btn-configure">&#x2699;&#xFE0F; Configure</button>
</div>
Expand All @@ -64,6 +70,22 @@ object HtmlContent {
</div>
</div>
<div id="popup" class="hidden"></div>
<div id="add-advanced-overlay" class="hidden">
<div id="add-advanced-modal" role="dialog" aria-modal="true" aria-labelledby="add-advanced-title">
<div id="add-advanced-title">Add project &#8212; Advanced</div>
<div id="add-advanced-body">
<p class="add-advanced-hint">Enter a directory path, URL, or glob pattern (e.g. <code>~/projects/*</code> or <code>s3://bucket/prefix</code>). Use <em>Storage options</em> to supply credentials or other fsspec options for remote filesystems.</p>
<label for="add-advanced-path">Path / pattern:</label>
<input type="text" id="add-advanced-path" autocomplete="off" spellcheck="false" placeholder="e.g. /home/user/projects or s3://my-bucket/ws/*" />
<label for="add-advanced-so" style="margin-top:10px;">Storage options (JSON, optional):</label>
<input type="text" id="add-advanced-so" autocomplete="off" spellcheck="false" placeholder='{"key": "AKIA&#8230;", "secret": "&#8230;"}' />
</div>
<div id="add-advanced-actions">
<button id="add-advanced-cancel" class="secondary">Cancel</button>
<button id="add-advanced-ok" class="primary">Add</button>
</div>
</div>
</div>
<div id="modal-overlay" class="hidden">
<div id="modal" role="dialog" aria-modal="true" aria-labelledby="modal-title">
<div id="modal-title">Create spec</div>
Expand Down Expand Up @@ -147,6 +169,63 @@ body { margin: 0; padding: 0; font-family: var(--vscode-font-family); color: var
border: none; padding: 4px 10px; cursor: pointer; font-size: 12px; border-radius: 3px;
}
.toolbar button:hover { background: var(--vscode-button-hoverBackground); }
.add-group { position: relative; display: flex; }
.add-group #btn-add { border-radius: 3px 0 0 3px; }
.add-group #btn-add-chevron { border-radius: 0 3px 3px 0; padding: 4px 6px; border-left: 1px solid var(--vscode-panel-border); }
.add-dropdown {
position: absolute; top: 100%; left: 0; z-index: 100; min-width: 160px;
background: var(--vscode-menu-background, var(--vscode-editorWidget-background));
color: var(--vscode-menu-foreground, var(--vscode-foreground));
border: 1px solid var(--vscode-menu-border, var(--vscode-panel-border));
border-radius: 3px; padding: 4px 0;
box-shadow: 0 2px 6px rgba(0,0,0,0.4);
}
.add-dropdown .menu-item { padding: 5px 12px; cursor: pointer; font-size: 12px; white-space: nowrap; }
.add-dropdown .menu-item:hover {
background: var(--vscode-list-activeSelectionBackground, var(--vscode-list-hoverBackground));
color: var(--vscode-list-activeSelectionForeground, var(--vscode-foreground));
}
#add-advanced-overlay {
position: fixed; inset: 0; background: rgba(0,0,0,0.4);
display: flex; align-items: center; justify-content: center;
z-index: 2000;
}
#add-advanced-modal {
background: var(--vscode-editorWidget-background);
color: var(--vscode-editorWidget-foreground, var(--vscode-foreground));
border: 1px solid var(--vscode-editorWidget-border, var(--vscode-panel-border));
border-radius: 6px; min-width: 420px; max-width: 85%;
box-shadow: 0 8px 24px rgba(0,0,0,0.5);
display: flex; flex-direction: column;
}
#add-advanced-title {
padding: 10px 14px; font-weight: bold; font-size: 14px;
border-bottom: 1px solid var(--vscode-panel-border);
}
#add-advanced-body { padding: 12px 14px; }
.add-advanced-hint {
font-size: 11px; color: var(--vscode-descriptionForeground);
margin: 0 0 10px 0; line-height: 1.5;
}
.add-advanced-hint code {
font-family: monospace; background: rgba(255,255,255,0.05);
padding: 0 3px; border-radius: 2px;
}
#add-advanced-body label {
display: block; font-size: 12px; margin-bottom: 4px;
color: var(--vscode-descriptionForeground);
}
#add-advanced-path, #add-advanced-so {
width: 100%; box-sizing: border-box;
background: var(--vscode-input-background); color: var(--vscode-input-foreground);
border: 1px solid var(--vscode-input-border, transparent);
padding: 6px 8px; font-size: 13px; border-radius: 3px; outline: none;
}
#add-advanced-path:focus, #add-advanced-so:focus { border-color: var(--vscode-focusBorder); }
#add-advanced-actions {
display: flex; justify-content: flex-end; gap: 6px;
padding: 10px 14px; border-top: 1px solid var(--vscode-panel-border);
}

.search { padding: 6px 8px; border-bottom: 1px solid var(--vscode-panel-border); }
.search-wrap { position: relative; display: flex; align-items: center; }
Expand Down Expand Up @@ -183,6 +262,7 @@ body { margin: 0; padding: 0; font-family: var(--vscode-font-family); color: var
.project .title { font-weight: bold; margin-right: 24px; }
.project .url { font-size: 11px; color: var(--vscode-descriptionForeground); word-break: break-all; margin-top: 2px; }
.project .storage-opts { font-size: 11px; color: var(--vscode-descriptionForeground); margin-top: 2px; font-style: italic; }
.project .meta { font-size: 11px; color: var(--vscode-descriptionForeground); margin-top: 2px; }
.project .chips { display: flex; flex-wrap: wrap; gap: 4px; margin-top: 6px; }

.chip {
Expand Down Expand Up @@ -466,6 +546,24 @@ body { margin: 0; padding: 0; font-family: var(--vscode-font-family); color: var
return idx >= 0 ? stripped.slice(idx + 1) : stripped;
} catch (_) { return url; }
}
function fmtSize(bytes) {
const units = ['B', 'KB', 'MB', 'GB', 'TB'];
let n = parseFloat(bytes);
for (let i = 0; i < units.length; i++) {
if (n < 1024 || i === units.length - 1)
return (i === 0 ? n.toFixed(0) : n.toFixed(1)) + ' ' + units[i];
n /= 1024;
}
}
function fmtAge(ts) {
const days = Math.floor((Date.now() / 1000 - parseFloat(ts)) / 86400);
if (days === 0) return 'today';
if (days === 1) return 'yesterday';
if (days < 30) return days + ' days ago';
if (days < 365) return Math.floor(days / 30) + ' months ago';
const yrs = Math.floor(days / 365);
return yrs + ' year' + (yrs > 1 ? 's' : '') + ' ago';
}
function specDisplayName(snake) { return snake; }
function iconForSpec(snake) {
const entry = info && info.specs && info.specs[snake];
Expand Down Expand Up @@ -533,6 +631,23 @@ body { margin: 0; padding: 0; font-family: var(--vscode-font-family); color: var
wrap.appendChild(so);
}

const metaParts = [];
if (project.file_count != null && project.total_size != null)
metaParts.push(parseInt(project.file_count).toLocaleString() + ' files, ' + fmtSize(project.total_size));
if (project.is_writable != null)
metaParts.push(project.is_writable === 'True' ? 'writable' : 'read-only');
if (project.last_modified != null) {
const age = fmtAge(project.last_modified);
const by = project.last_modified_by != null ? project.last_modified_by : null;
metaParts.push('last modified ' + age + (by ? ' by ' + by : ''));
}
if (metaParts.length > 0) {
const meta = document.createElement('div');
meta.className = 'meta';
meta.textContent = metaParts.join(' · ');
wrap.appendChild(meta);
}

const chips = document.createElement('div');
chips.className = 'chips';
const contents = project.contents || {};
Expand Down Expand Up @@ -1122,7 +1237,61 @@ body { margin: 0; padding: 0; font-family: var(--vscode-font-family); color: var
});

// ----- toolbar -----
document.getElementById('btn-add').addEventListener('click', () => vscode.postMessage({ cmd: 'add' }));
const addDropdown = document.getElementById('add-dropdown');
document.getElementById('btn-add').addEventListener('click', () => {
addDropdown.classList.add('hidden');
vscode.postMessage({ cmd: 'add' });
});
document.getElementById('btn-add-chevron').addEventListener('click', (e) => {
e.stopPropagation();
addDropdown.classList.toggle('hidden');
});
document.getElementById('add-local').addEventListener('click', () => {
addDropdown.classList.add('hidden');
vscode.postMessage({ cmd: 'add' });
});
document.getElementById('add-advanced').addEventListener('click', () => {
addDropdown.classList.add('hidden');
openAddAdvancedModal();
});
document.addEventListener('click', () => addDropdown.classList.add('hidden'));

// ----- advanced-add modal -----
const addAdvancedOverlay = document.getElementById('add-advanced-overlay');
const addAdvancedPath = document.getElementById('add-advanced-path');
const addAdvancedSo = document.getElementById('add-advanced-so');
const addAdvancedOk = document.getElementById('add-advanced-ok');
const addAdvancedCancel = document.getElementById('add-advanced-cancel');

function openAddAdvancedModal() {
addAdvancedPath.value = '';
addAdvancedSo.value = '';
addAdvancedOverlay.classList.remove('hidden');
setTimeout(() => addAdvancedPath.focus(), 0);
}
function closeAddAdvancedModal() {
addAdvancedOverlay.classList.add('hidden');
}
function submitAddAdvanced() {
const p = addAdvancedPath.value.trim();
if (!p) return;
const so = addAdvancedSo.value.trim();
closeAddAdvancedModal();
vscode.postMessage({ cmd: 'addConfirmed', path: p, storageOptions: so });
}
addAdvancedOk.addEventListener('click', submitAddAdvanced);
addAdvancedCancel.addEventListener('click', closeAddAdvancedModal);
addAdvancedOverlay.addEventListener('click', (e) => {
if (e.target === addAdvancedOverlay) closeAddAdvancedModal();
});
addAdvancedPath.addEventListener('keydown', (e) => {
if (e.key === 'Enter') submitAddAdvanced();
if (e.key === 'Escape') closeAddAdvancedModal();
});
addAdvancedSo.addEventListener('keydown', (e) => {
if (e.key === 'Enter') submitAddAdvanced();
if (e.key === 'Escape') closeAddAdvancedModal();
});
document.getElementById('btn-reload').addEventListener('click', () => vscode.postMessage({ cmd: 'reload' }));
document.getElementById('btn-configure').addEventListener('click', () => vscode.postMessage({ cmd: 'configure' }));
searchEl.addEventListener('input', () => render());
Expand Down
4 changes: 2 additions & 2 deletions src/projspec/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
import projspec.content
import projspec.artifact
import projspec.config
from projspec.utils import get_cls
from projspec.utils import get_cls, scan_glob

__all__ = ["Project", "ProjectSpec", "get_cls"]
__all__ = ["Project", "ProjectSpec", "get_cls", "scan_glob"]
57 changes: 33 additions & 24 deletions src/projspec/__main__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ def version():


@main.command("scan")
@click.argument("path", default=".")
@click.argument("patterns", nargs=-1)
@click.option(
"--storage_options",
default="",
Expand Down Expand Up @@ -101,11 +101,13 @@ def version():
default=False,
help="HTML output, for projects only",
)
@click.option("--walk", is_flag=True, help="To descend into all child directories")
@click.option(
"--walk", is_flag=True, help="Descend into child directories of each match"
)
@click.option("--summary", is_flag=True, help="Show abbreviated output")
@click.option("--library", is_flag=True, help="Add to library")
@click.option("--library", is_flag=True, help="Add each result to the library")
def scan(
path,
patterns,
storage_options,
types,
xtypes,
Expand All @@ -115,32 +117,39 @@ def scan(
summary,
library,
):
"""Scan the given path for projects, and display
"""Scan directories and display results.

path: str, path to the project directory, defaults to "."
PATTERNS is one or more directory paths or glob expressions. When the
shell expands a glob before invoking projspec, each expanded path is
passed as a separate argument. Glob expressions containing wildcards
(e.g. '~/projects/*') are expanded by projspec itself via fsspec.
If no PATTERNS are given, the current directory is scanned.
"""
from projspec.utils import scan_glob

if types in {"ALL", ""}:
types = None
else:
types = types.split(",")
proj = projspec.Project(
path,
storage_options=storage_options,
types=types,
xtypes=xtypes,
walk=walk,
)
if summary:
print(proj.text_summary())
else:
if json_out:
print(json.dumps(proj.to_dict(compact=False)))
elif html_out:
print(proj._repr_html_())
else:
print(proj)
if library:
proj.add_to_library()

for pattern in patterns or (".",):
for proj in scan_glob(
pattern,
types=types,
xtypes=xtypes,
walk=walk,
storage_options=storage_options,
add_to_library=library,
):
if summary:
print(proj.text_summary())
else:
if json_out:
print(json.dumps(proj.to_dict(compact=False)))
elif html_out:
print(proj._repr_html_())
else:
print(proj)


@main.command("info")
Expand Down
Loading
Loading