上传项目到 Overleaf

[YDX-2147483647]

src/upload.js

/**
 * 上传项目到 Overleaf
 * 
 * node upload.js EMAIL PASSWORD DIR VERSION
 * 例： node upload.js [email protected] password ./files v3.7.9
 */

import { argv } from 'node:process'

import { firefox } from "playwright"

const TEMPLATES = [
  "undergraduate-thesis-en",
  "undergraduate-thesis",
  "reading-report",
  "presentation-slide",
  "lab-report",
  "graduate-thesis",
]

/**
 * 登录
 * @param {import('playwright').Browser} browser
 * @param {{email: string, password: string}} param1
 * @returns {Promise<import('playwright').Page>}
 */
async function login (browser, { email, password }) {
  const page = await browser.newPage()
  await page.goto("https://cn.overleaf.com/login?")

  await page.getByLabel("电子邮件").fill(email)
  await page.getByLabel("密码").fill(password)
  await page.getByRole("button", { name: "登录" }).click()
  await page.waitForURL("https://cn.overleaf.com/project")

  return page
}

/**
 * 上传项目并返回主页
 *
 * @param {import('playwright').Page} page
 * @param {string} file
 * @returns {Promise<string>} 只读链接
 */
async function upload_project (page, file) {
  // 上传项目
  await page.getByRole("button", { name: "创建新项目" }).click()
  await page.getByRole("menuitem", { name: "上传项目" }).click()
  await page.locator("input[type=file]:not([webkitdirectory])").setInputFiles(file)
  // 上传较慢，专门等一下。
  await page.waitForURL("https://cn.overleaf.com/project/*")

  // 设置编译器
  await page.getByLabel("项目布局、分享和提交").getByRole("button", { name: "菜单" }).click()
  await page.getByLabel("编译器").selectOption("xelatex")
  await page.locator("#left-menu-modal").click()

  // 获取分享链接
  await page.getByRole("button", { name: "共享" }).click()
  await page.getByRole("button", { name: "开启通过链接分享功能。" }).click()
  const link = await page.getByText("https://cn.overleaf.com/read/").innerText()
  await page.getByRole("button", { name: "关闭", exact: true }).click()
  await page.getByRole("link", { name: "返回您的项目" }).click()

  return link
}

const browser = await firefox.launch({
  headless: false, // 因为登录有很小但非零的概率需要验证码
  slowMo: 50,
})

const page = await login(browser, {
  email: argv[2],
  password: argv[3],
})

for (const t of TEMPLATES) {
  const file = `${argv[4]}/BIThesis-${t}-${argv[5]}.zip`
  const link = await upload_project(page, file)
  console.log(`[${t}]: ${link}`)
}

await browser.close()

package.json

{
  "name": "overleaf",
  "version": "1.0.0",
  "description": "",
  "private": true,
  "type": "module",
  "scripts": {
    "upload": "node src/upload.js"
  },
  "keywords": [],
  "author": "",
  "license": "MIT",
  "devDependencies": {
    "@playwright/browser-firefox": "^1.44.1",
    "playwright": "^1.44.1"
  }
}

pnpm-lock.yaml

lockfileVersion: '9.0'

settings:
  autoInstallPeers: true
  excludeLinksFromLockfile: false

importers:

  .:
    devDependencies:
      '@playwright/browser-firefox':
        specifier: ^1.44.1
        version: 1.44.1
      playwright:
        specifier: ^1.44.1
        version: 1.44.1

packages:

  '@playwright/[email protected]':
    resolution: {integrity: sha512-B8lZ0PQsekEjcpIgE6VkYXhvzALTGpgjKxESxDSwOr0svpduo/BzQ4dkyWiSfgX5XcrSjxYsNI09VSB0g1ZSWg==}
    engines: {node: '>=16'}

  [email protected]:
    resolution: {integrity: sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==}
    engines: {node: ^8.16.0 || ^10.6.0 || >=11.0.0}
    os: [darwin]

  [email protected]:
    resolution: {integrity: sha512-wh0JWtYTrhv1+OSsLPgFzGzt67Y7BE/ZS3jEqgGBlp2ppp1ZDj8c+9IARNW4dwf1poq5MgHreEM2KV/GuR4cFA==}
    engines: {node: '>=16'}
    hasBin: true

  [email protected]:
    resolution: {integrity: sha512-qr/0UJ5CFAtloI3avF95Y0L1xQo6r3LQArLIg/z/PoGJ6xa+EwzrwO5lpNr/09STxdHuUoP2mvuELJS+hLdtgg==}
    engines: {node: '>=16'}
    hasBin: true

snapshots:

  '@playwright/[email protected]':
    dependencies:
      playwright-core: 1.44.1

  [email protected]:
    optional: true

  [email protected]: {}

  [email protected]:
    dependencies:
      playwright-core: 1.44.1
    optionalDependencies:
      fsevents: 2.3.2

[phy25]

好奇这个的用意只是通过 CLI 获得个人文档的分享链接吗？

另可参见 https://www.overleaf.com/devs

[YDX-2147483647]

• 若是直接放 https://www.overleaf.com/docs 链接

  • 优点
    • 同学不用自己 Copy Project 了。
    • 如果参数直接指向 GitHub，以后也不用更新网站了。
  • 缺点
    • 参数要么指向 GitHub 并附文件路径（难以控制版本），要么自己用某种服务挂上 ZIP（未必可靠）。

• 若只用 https://www.overleaf.com/docs 链接上传，发布时还是分享 https://cn.overleaf.com/read/ 链接

  似乎没有分享链接的API，所以区别不是很大。

[fky2015]

参数要么指向 GitHub 并附文件路径（难以控制版本）

latest release 可能也是可以的

[YDX-2147483647]

latest release 可能也是可以的

指向 latest release 中的 ZIP 吗？去掉嵌套文件夹， 加engine=xelatex，也许可用。

---

似乎会自动拆开嵌套文件夹。

https://cn.overleaf.com/docs?engine=xelatex&snip_uri=https://github.com/BITNP/BIThesis/releases/latest/download/undergraduate-thesis.zip

[fky2015]

看上去很不错

[YDX-2147483647]

BITNP/BIThesis-wiki#316

#530