vscode-offline 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

vscode_offline/app.py

@@ -6,8 +6,12 @@ from pathlib import Path
 
 from vscode_offline.download import download_vscode_extensions, download_vscode_server
 from vscode_offline.install import install_vscode_extensions, install_vscode_server
-from vscode_offline.paths import (
+from vscode_offline.loggers import logger
+from vscode_offline.utils import (
+    get_target_platform_from_installer,
     get_vscode_cli_bin,
+    get_vscode_commit_from_code_version,
+    get_vscode_commit_from_installer,
     get_vscode_extensions_config,
     get_vscode_server_home,
 )
@@ -18,6 +22,14 @@ cli_os_mapping = {
 
 
 def download(args: Namespace) -> None:
+    if args.commit is None:
+        args.commit = get_vscode_commit_from_code_version()
+        if args.commit is None:
+            logger.info(
+                "Cannot determine commit from `code --version`, please specify --commit manually."
+            )
+            raise ValueError("Please specify --commit when installing.")
+
     download_vscode_server(
         args.commit,
         output=args.installer / f"cli-{args.commit}",
@@ -31,9 +43,27 @@ def download(args: Namespace) -> None:
 
 
 def install(args: Namespace) -> None:
+    if args.commit is None:
+        args.commit = get_vscode_commit_from_installer(args.installer)
+        if args.commit is None:
+            logger.info(
+                f"Cannot determine commit from `{args.installer}`, please specify --commit manually."
+            )
+            raise ValueError("Please specify --commit when installing.")
+
+    if args.target_platform is None:
+        args.target_platform = get_target_platform_from_installer(
+            args.installer / f"cli-{args.commit}"
+        )
+        if args.target_platform is None:
+            logger.info(
+                f"Cannot determine target platform from `{args.installer}`, please specify --target-platform manually."
+            )
+            raise ValueError("Please specify --target-platform when installing.")
+
     install_vscode_server(
         args.commit,
-        installer=args.installer / f"cli-{args.commit}",
+        cli_installer=args.installer / f"cli-{args.commit}",
         vscode_cli_bin=get_vscode_cli_bin(args.commit),
         target_platform=args.target_platform,
         cli_os=cli_os_mapping[args.target_platform],
@@ -48,18 +78,6 @@ def install(args: Namespace) -> None:
 def make_argparser() -> ArgumentParser:
     parent_parser = ArgumentParser(add_help=False)
 
-    parent_parser.add_argument(
-        "--commit",
-        type=str,
-        required=True,
-        help="The commit hash of the VSCode server to download, must match the version of the VSCode client.",
-    )
-    parent_parser.add_argument(
-        "--target-platform",
-        type=str,
-        default="linux-x64",
-        help="The target platform for the VSCode server.",
-    )
     parent_parser.add_argument(
         "--installer",
         type=Path,
@@ -76,6 +94,17 @@ def make_argparser() -> ArgumentParser:
         parents=[parent_parser],
     )
     download_parser.set_defaults(func=download)
+    download_parser.add_argument(
+        "--commit",
+        type=str,
+        help="The commit hash of the VSCode server to download, must match the version of the VSCode client.",
+    )
+    download_parser.add_argument(
+        "--target-platform",
+        type=str,
+        required=True,
+        help="The target platform of the VSCode server to download.",
+    )
     download_parser.add_argument(
         "--extensions-config",
         type=Path,
@@ -83,12 +112,22 @@ def make_argparser() -> ArgumentParser:
         help="Path to the extensions configuration file. Will search for extensions to download.",
     )
 
-    install_parsers = subparsers.add_parser(
+    install_parser = subparsers.add_parser(
         "install",
         help="Install VSCode server and extensions",
         parents=[parent_parser],
     )
-    install_parsers.set_defaults(func=install)
+    install_parser.set_defaults(func=install)
+    install_parser.add_argument(
+        "--commit",
+        type=str,
+        help="The commit hash of the VSCode server to install.",
+    )
+    install_parser.add_argument(
+        "--target-platform",
+        type=str,
+        help="The target platform of the VSCode server to install.",
+    )
 
     return parser
 

vscode_offline/download.py

@@ -13,7 +13,7 @@ def _download_file(url: str, filename: str) -> None:
     with urlopen(url) as resp:
         content_encoding = resp.headers.get("Content-Encoding")
         if content_encoding in {"gzip", "deflate"}:
-            logger.info(f"Content encoding is {content_encoding}, using GzipFile")
+            logger.info(f"Content-Encoding is {content_encoding}, using GzipFile")
             reader = GzipFile(fileobj=resp)
         elif not content_encoding:
             reader = resp

vscode_offline/install.py

@@ -6,8 +6,9 @@ from pathlib import Path
 from tempfile import TemporaryDirectory
 
 from vscode_offline.loggers import logger
-from vscode_offline.paths import get_vscode_server_home
+from vscode_offline.utils import get_vscode_server_home
 
+# These extensions are excluded because they are not needed in a VSCode server.
 EXCLUDE_EXTENSIONS = {
     "ms-vscode-remote.remote-ssh",
     "ms-vscode-remote.remote-ssh-edit",
@@ -39,14 +40,14 @@ def install_vscode_extensions(vscode_bin: os.PathLike[str], vsix_dir: str) -> No
 
 def install_vscode_server(
     commit: str,
-    installer: str,
+    cli_installer: str,
     vscode_cli_bin: os.PathLike[str],
     target_platform: str,
     cli_os: str,
 ) -> None:
     cli_os_ = cli_os.replace("-", "_")
 
-    vscode_cli_tarball = Path(installer) / f"vscode_{cli_os_}_cli.tar.gz"
+    vscode_cli_tarball = Path(cli_installer) / f"vscode_{cli_os_}_cli.tar.gz"
     with TemporaryDirectory() as tmpdir:
         subprocess.check_call(["tar", "-xzf", vscode_cli_tarball, "-C", tmpdir])
         tmpfile = Path(tmpdir) / "code"
@@ -56,7 +57,9 @@ def install_vscode_server(
         os.rename(tmpfile, vscode_cli_bin)
     logger.info(f"Extracted vscode_{cli_os_}_cli.tar.gz to {vscode_cli_bin}")
 
-    vscode_server_tarball = Path(installer) / f"vscode-server-{target_platform}.tar.gz"
+    vscode_server_tarball = (
+        Path(cli_installer) / f"vscode-server-{target_platform}.tar.gz"
+    )
     vscode_server_home = get_vscode_server_home(commit)
     os.makedirs(vscode_server_home, exist_ok=True)
     subprocess.check_call(

vscode_offline/utils.py

@@ -0,0 +1,56 @@
+from __future__ import annotations
+
+import os
+import subprocess
+from pathlib import Path
+from vscode_offline.loggers import logger
+
+VSCODE_DATA = Path("~/.vscode").expanduser()
+VSCODE_SERVER_DATA = Path("~/.vscode-server").expanduser()
+
+
+def get_vscode_cli_bin(commit: str) -> os.PathLike[str]:
+    return VSCODE_SERVER_DATA / f"code-{commit}"
+
+
+def get_vscode_server_home(commit: str) -> os.PathLike[str]:
+    return VSCODE_SERVER_DATA / f"cli/servers/Stable-{commit}/server"
+
+
+def get_vscode_extensions_config() -> os.PathLike[str]:
+    p = VSCODE_DATA / "extensions/extensions.json"
+    if p.exists():
+        return p
+    s = VSCODE_SERVER_DATA / "extensions/extensions.json"
+    if s.exists():
+        return s
+    return p  # default to this path
+
+
+def get_vscode_commit_from_installer(installer: os.PathLike[str]) -> str | None:
+    directories = list(Path(installer).glob("cli-*"))
+    if len(directories) == 1:
+        return directories[0].name[len("cli-") :]
+    return None
+
+
+def get_vscode_commit_from_code_version() -> str | None:
+    res = subprocess.run(["code", "--version"], stdout=subprocess.PIPE)
+    if res.returncode != 0:
+        return None
+    lines = res.stdout.splitlines()
+    if len(lines) < 2:
+        return None  # Unexpected output
+
+    # The commit hash is usually on the second line
+    commit = lines[1].strip().decode("utf-8")
+    logger.info(f"Getting commit from `code --version`: {commit}")
+
+    return lines[1].strip().decode("utf-8")
+
+
+def get_target_platform_from_installer(cli_installer: str) -> str | None:
+    directories = list(Path(cli_installer).glob("vscode-server-*.tar.gz"))
+    if len(directories) == 1:
+        return directories[0].name[len("vscode-server-") : -len(".tar.gz")]
+    return None

{vscode_offline-0.1.0.dist-info → vscode_offline-0.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: vscode-offline
-Version: 0.1.0
+Version: 0.1.1
 Summary: Download and install vscode server for offline environments
 Author: Chuck Fan
 Author-email: Chuck Fan <fanck0605@qq.com>
@@ -17,17 +17,23 @@ vscode-offline 主要用于在无网环境下安装 VSCode Server，方便使用
 pip install -U vscode-offline
 ```
 
+## 优势
+
+1. 自动识别并下载所有 `.vsix` 文件（包括间接依赖）
+2. 一键安装 VSCode server 以及所有插件
+
 ## 用法
 
 （1）在联网环境安装好 VSCode 和你需要的插件。
 
-（2）联网环境执行如下命令，将会自动下载当前 VSCode 所有的插件
+（2）联网环境执行如下命令，将会自动下载 VSCode server，和目前安装的所有的插件
 
-> `--commit` 为对应 VSCode 的 Commit 号，*帮助* -> *关于* -> *Commit*
+> `--commit` 可以指定对应 VSCode 的 Commit，默认自动获取当前环境 VSCode 的 Commit。
+>
+> 手动查看方式：*帮助* -> *关于* -> *Commit*，
 
 ```shell
 vscode-offline download \
-    --commit 385651c938df8a906869babee516bffd0ddb9829 \
     --target-platform linux-x64 \
     --installer ./vscode-offline-installer
 ```
@@ -35,10 +41,7 @@ vscode-offline download \
 （3）复制 `vscode-offline-installer` 到内网服务器
 
 ```shell
-vscode-offline install \
-    --commit 385651c938df8a906869babee516bffd0ddb9829 \
-    --target-platform linux-x64 \
-    --installer ./vscode-offline-installer
+vscode-offline install --installer ./vscode-offline-installer
 ```
 
 ## 贡献

vscode_offline-0.1.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+vscode_offline/__init__.py,sha256=dr6Jtj0XT9eQEC4fzNigEYsAIEfCsaom3HDbUsS-2O4,57
+vscode_offline/app.py,sha256=OXvwedUn8RepP37Ps-jXCBrBVqsl8Fd5hJni355fRnM,4623
+vscode_offline/download.py,sha256=EpKgNLF6jU26vH-tI9UJx_acTUPIXpDnofGpY6RWmGI,3478
+vscode_offline/install.py,sha256=_LwsxCqSu8_9uaSY1zuJc9nxTYbXo6f9FKzMAL9DeJo,2662
+vscode_offline/loggers.py,sha256=vX91NMtNo1xfxq5y4BCtm_uhCTKtCODqBJHNvcT7JdQ,104
+vscode_offline/utils.py,sha256=Unmb8V-q_s4tyxfzmh7wayyM4OM83K-HqlQKqe49LpI,1749
+vscode_offline-0.1.1.dist-info/WHEEL,sha256=-neZj6nU9KAMg2CnCY6T3w8J53nx1kFGw_9HfoSzM60,79
+vscode_offline-0.1.1.dist-info/entry_points.txt,sha256=zIMeh_ENKKzlt9lDao8icofSI0TeCQxH8eCwxIRI2G8,56
+vscode_offline-0.1.1.dist-info/METADATA,sha256=xzRd7KZw0gVgZPu5ZN8SEv3lDS7r18ql3V-L6IDHJYY,1283
+vscode_offline-0.1.1.dist-info/RECORD,,

vscode_offline/paths.py

@@ -1,25 +0,0 @@
-from __future__ import annotations
-
-import os
-from pathlib import Path
-
-VSCODE_DATA = Path("~/.vscode").expanduser()
-VSCODE_SERVER_DATA = Path("~/.vscode-server").expanduser()
-
-
-def get_vscode_cli_bin(commit: str) -> os.PathLike[str]:
-    return VSCODE_SERVER_DATA / f"code-{commit}"
-
-
-def get_vscode_server_home(commit: str) -> os.PathLike[str]:
-    return VSCODE_SERVER_DATA / f"cli/servers/Stable-{commit}/server"
-
-
-def get_vscode_extensions_config() -> os.PathLike[str]:
-    p = VSCODE_DATA / "extensions/extensions.json"
-    if p.exists():
-        return p
-    s = VSCODE_SERVER_DATA / "extensions/extensions.json"
-    if s.exists():
-        return s
-    return p  # default to this path

vscode_offline-0.1.0.dist-info/RECORD

@@ -1,10 +0,0 @@
-vscode_offline/__init__.py,sha256=dr6Jtj0XT9eQEC4fzNigEYsAIEfCsaom3HDbUsS-2O4,57
-vscode_offline/app.py,sha256=pdr7F7vjDVIupkaZSoqL1ZAWNZPAGyPx52lLtcTUYpo,3052
-vscode_offline/download.py,sha256=thEFFn4XuoHqH0f6cuUcOWWeUQwNhPjKO5d681xIyL4,3478
-vscode_offline/install.py,sha256=D4klu6aKeqp6bSQkWLzFmaTNalvekw5L93Y4FQs-jFA,2554
-vscode_offline/loggers.py,sha256=vX91NMtNo1xfxq5y4BCtm_uhCTKtCODqBJHNvcT7JdQ,104
-vscode_offline/paths.py,sha256=WnOzG6a7PXFurgkVUirHtIyRDnF80PzjKHtdMXSlcbU,693
-vscode_offline-0.1.0.dist-info/WHEEL,sha256=-neZj6nU9KAMg2CnCY6T3w8J53nx1kFGw_9HfoSzM60,79
-vscode_offline-0.1.0.dist-info/entry_points.txt,sha256=zIMeh_ENKKzlt9lDao8icofSI0TeCQxH8eCwxIRI2G8,56
-vscode_offline-0.1.0.dist-info/METADATA,sha256=Zi7Fel9ALNPmqHosPrBhRa0X8y8BAaS-9YkVbhONa08,1198
-vscode_offline-0.1.0.dist-info/RECORD,,