一个工具,可以轻松地将所有源代码自动写入json文件,然后
code2json的Python项目详细描述
代码2 JSON
一种命令行实用程序,可以将代码插入json文件,并从json中提取代码插入源代码文件。
功能
- 在单独的文件中创建源代码,并使用源代码中的标记将它们自动写入json
- 将目录及其子目录中的所有文件写入json
- 指定源代码文件的扩展名
- 指定源代码中用于指示标记部分的标识符的分隔符(如果该语言不支持默认分隔符(
//
),则该分隔符很有用 - 根据json中的源代码更新源代码
计划功能
- 一种安全模式,允许用户在提交更改之前检查所做的更改
要求
- python 3:我使用python3风格的打印函数,我只是不想支持python 2,特别是在2020/01/01之后,它将不受支持
- (可选)pip:python包安装程序可用于轻松安装code 2 json,但这也可以手动完成
安装
有多种方法可以安装代码2 json:
使用pip和pypi
只需运行以下命令
pip install code2json
克隆存储库并安装pip
- 克隆存储库
git clone https://gitlab.com/Deathray_II/code2json.git
如果您喜欢使用ssh
git clone git@gitlab.com:Deathray_II/code2json.git
- 进入git目录
cd code2json
- 在安装文件上运行pip install
pip install .
或者如果您只想为您的用户安装它
pip install --user .
克隆存储库并手动安装(在Linux上)
- 克隆存储库
git clone https://gitlab.com/Deathray_II/code2json.git
如果您喜欢使用ssh
git clone git@gitlab.com:Deathray_II/code2json.git
- 在你的壳里变得容易接近
有两种方法可以做到这一点:添加别名或将其链接到
/usr/bin
文件夹- 添加别名:
找到您的
~/.bashrc
或~/.zshrc
并添加alisas code2json=/path/to/cmd.py "$@"
行,其中/path/to/cmd.py
是存储库中src/code2json/
文件夹中cmd.py
文件的路径。 - 将它链接到
/usr/bin
:运行命令ln -s /path/to/cmd.py /usr/bin/code2json
(作为有权在/usr/bin
中写入的用户),其中/path/to/cmd.py
是存储库中src/code2json/
文件夹中cmd.py
文件的路径。
- 添加别名:
找到您的
用法
如果已经克隆了存储库,您可以查看测试文件并对其尝试某些命令,以便了解其工作原理
json代码
如果我们希望将文件(apples.c
)中的所有代码写入相应的json文件,我们将从包含源文件的文件夹中执行以下命令
code2json ./apples.c .c 2json
如果我们希望将当前目录下的所有.js文件写入它们的json文件,我们将运行以下命令。
code2json . .js 2json
json到代码
code2json ./apples.c .c 2code
code2json . .js 2json