├── LICENSE
├── README.md
├── Scripts
    └── leetcode-quickadd.js
├── Templates
    └── leetcode-problem-template.md
└── docs
    └── Screenshots
        ├── autogen-problem-screenshot.png
        ├── autogen-properties-screenshot.png
        ├── dataview-effective-tagging.png
        ├── image-in-example-screenshot.png
        └── problem-search-screenshot.png


/LICENSE:
--------------------------------------------------------------------------------
  1 | Mozilla Public License Version 2.0
  2 | ==================================
  3 | 
  4 | 1. Definitions
  5 | --------------
  6 | 
  7 | 1.1. "Contributor"
  8 |     means each individual or legal entity that creates, contributes to
  9 |     the creation of, or owns Covered Software.
 10 | 
 11 | 1.2. "Contributor Version"
 12 |     means the combination of the Contributions of others (if any) used
 13 |     by a Contributor and that particular Contributor's Contribution.
 14 | 
 15 | 1.3. "Contribution"
 16 |     means Covered Software of a particular Contributor.
 17 | 
 18 | 1.4. "Covered Software"
 19 |     means Source Code Form to which the initial Contributor has attached
 20 |     the notice in Exhibit A, the Executable Form of such Source Code
 21 |     Form, and Modifications of such Source Code Form, in each case
 22 |     including portions thereof.
 23 | 
 24 | 1.5. "Incompatible With Secondary Licenses"
 25 |     means
 26 | 
 27 |     (a) that the initial Contributor has attached the notice described
 28 |         in Exhibit B to the Covered Software; or
 29 | 
 30 |     (b) that the Covered Software was made available under the terms of
 31 |         version 1.1 or earlier of the License, but not also under the
 32 |         terms of a Secondary License.
 33 | 
 34 | 1.6. "Executable Form"
 35 |     means any form of the work other than Source Code Form.
 36 | 
 37 | 1.7. "Larger Work"
 38 |     means a work that combines Covered Software with other material, in
 39 |     a separate file or files, that is not Covered Software.
 40 | 
 41 | 1.8. "License"
 42 |     means this document.
 43 | 
 44 | 1.9. "Licensable"
 45 |     means having the right to grant, to the maximum extent possible,
 46 |     whether at the time of the initial grant or subsequently, any and
 47 |     all of the rights conveyed by this License.
 48 | 
 49 | 1.10. "Modifications"
 50 |     means any of the following:
 51 | 
 52 |     (a) any file in Source Code Form that results from an addition to,
 53 |         deletion from, or modification of the contents of Covered
 54 |         Software; or
 55 | 
 56 |     (b) any new file in Source Code Form that contains any Covered
 57 |         Software.
 58 | 
 59 | 1.11. "Patent Claims" of a Contributor
 60 |     means any patent claim(s), including without limitation, method,
 61 |     process, and apparatus claims, in any patent Licensable by such
 62 |     Contributor that would be infringed, but for the grant of the
 63 |     License, by the making, using, selling, offering for sale, having
 64 |     made, import, or transfer of either its Contributions or its
 65 |     Contributor Version.
 66 | 
 67 | 1.12. "Secondary License"
 68 |     means either the GNU General Public License, Version 2.0, the GNU
 69 |     Lesser General Public License, Version 2.1, the GNU Affero General
 70 |     Public License, Version 3.0, or any later versions of those
 71 |     licenses.
 72 | 
 73 | 1.13. "Source Code Form"
 74 |     means the form of the work preferred for making modifications.
 75 | 
 76 | 1.14. "You" (or "Your")
 77 |     means an individual or a legal entity exercising rights under this
 78 |     License. For legal entities, "You" includes any entity that
 79 |     controls, is controlled by, or is under common control with You. For
 80 |     purposes of this definition, "control" means (a) the power, direct
 81 |     or indirect, to cause the direction or management of such entity,
 82 |     whether by contract or otherwise, or (b) ownership of more than
 83 |     fifty percent (50%) of the outstanding shares or beneficial
 84 |     ownership of such entity.
 85 | 
 86 | 2. License Grants and Conditions
 87 | --------------------------------
 88 | 
 89 | 2.1. Grants
 90 | 
 91 | Each Contributor hereby grants You a world-wide, royalty-free,
 92 | non-exclusive license:
 93 | 
 94 | (a) under intellectual property rights (other than patent or trademark)
 95 |     Licensable by such Contributor to use, reproduce, make available,
 96 |     modify, display, perform, distribute, and otherwise exploit its
 97 |     Contributions, either on an unmodified basis, with Modifications, or
 98 |     as part of a Larger Work; and
 99 | 
100 | (b) under Patent Claims of such Contributor to make, use, sell, offer
101 |     for sale, have made, import, and otherwise transfer either its
102 |     Contributions or its Contributor Version.
103 | 
104 | 2.2. Effective Date
105 | 
106 | The licenses granted in Section 2.1 with respect to any Contribution
107 | become effective for each Contribution on the date the Contributor first
108 | distributes such Contribution.
109 | 
110 | 2.3. Limitations on Grant Scope
111 | 
112 | The licenses granted in this Section 2 are the only rights granted under
113 | this License. No additional rights or licenses will be implied from the
114 | distribution or licensing of Covered Software under this License.
115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a
116 | Contributor:
117 | 
118 | (a) for any code that a Contributor has removed from Covered Software;
119 |     or
120 | 
121 | (b) for infringements caused by: (i) Your and any other third party's
122 |     modifications of Covered Software, or (ii) the combination of its
123 |     Contributions with other software (except as part of its Contributor
124 |     Version); or
125 | 
126 | (c) under Patent Claims infringed by Covered Software in the absence of
127 |     its Contributions.
128 | 
129 | This License does not grant any rights in the trademarks, service marks,
130 | or logos of any Contributor (except as may be necessary to comply with
131 | the notice requirements in Section 3.4).
132 | 
133 | 2.4. Subsequent Licenses
134 | 
135 | No Contributor makes additional grants as a result of Your choice to
136 | distribute the Covered Software under a subsequent version of this
137 | License (see Section 10.2) or under the terms of a Secondary License (if
138 | permitted under the terms of Section 3.3).
139 | 
140 | 2.5. Representation
141 | 
142 | Each Contributor represents that the Contributor believes its
143 | Contributions are its original creation(s) or it has sufficient rights
144 | to grant the rights to its Contributions conveyed by this License.
145 | 
146 | 2.6. Fair Use
147 | 
148 | This License is not intended to limit any rights You have under
149 | applicable copyright doctrines of fair use, fair dealing, or other
150 | equivalents.
151 | 
152 | 2.7. Conditions
153 | 
154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155 | in Section 2.1.
156 | 
157 | 3. Responsibilities
158 | -------------------
159 | 
160 | 3.1. Distribution of Source Form
161 | 
162 | All distribution of Covered Software in Source Code Form, including any
163 | Modifications that You create or to which You contribute, must be under
164 | the terms of this License. You must inform recipients that the Source
165 | Code Form of the Covered Software is governed by the terms of this
166 | License, and how they can obtain a copy of this License. You may not
167 | attempt to alter or restrict the recipients' rights in the Source Code
168 | Form.
169 | 
170 | 3.2. Distribution of Executable Form
171 | 
172 | If You distribute Covered Software in Executable Form then:
173 | 
174 | (a) such Covered Software must also be made available in Source Code
175 |     Form, as described in Section 3.1, and You must inform recipients of
176 |     the Executable Form how they can obtain a copy of such Source Code
177 |     Form by reasonable means in a timely manner, at a charge no more
178 |     than the cost of distribution to the recipient; and
179 | 
180 | (b) You may distribute such Executable Form under the terms of this
181 |     License, or sublicense it under different terms, provided that the
182 |     license for the Executable Form does not attempt to limit or alter
183 |     the recipients' rights in the Source Code Form under this License.
184 | 
185 | 3.3. Distribution of a Larger Work
186 | 
187 | You may create and distribute a Larger Work under terms of Your choice,
188 | provided that You also comply with the requirements of this License for
189 | the Covered Software. If the Larger Work is a combination of Covered
190 | Software with a work governed by one or more Secondary Licenses, and the
191 | Covered Software is not Incompatible With Secondary Licenses, this
192 | License permits You to additionally distribute such Covered Software
193 | under the terms of such Secondary License(s), so that the recipient of
194 | the Larger Work may, at their option, further distribute the Covered
195 | Software under the terms of either this License or such Secondary
196 | License(s).
197 | 
198 | 3.4. Notices
199 | 
200 | You may not remove or alter the substance of any license notices
201 | (including copyright notices, patent notices, disclaimers of warranty,
202 | or limitations of liability) contained within the Source Code Form of
203 | the Covered Software, except that You may alter any license notices to
204 | the extent required to remedy known factual inaccuracies.
205 | 
206 | 3.5. Application of Additional Terms
207 | 
208 | You may choose to offer, and to charge a fee for, warranty, support,
209 | indemnity or liability obligations to one or more recipients of Covered
210 | Software. However, You may do so only on Your own behalf, and not on
211 | behalf of any Contributor. You must make it absolutely clear that any
212 | such warranty, support, indemnity, or liability obligation is offered by
213 | You alone, and You hereby agree to indemnify every Contributor for any
214 | liability incurred by such Contributor as a result of warranty, support,
215 | indemnity or liability terms You offer. You may include additional
216 | disclaimers of warranty and limitations of liability specific to any
217 | jurisdiction.
218 | 
219 | 4. Inability to Comply Due to Statute or Regulation
220 | ---------------------------------------------------
221 | 
222 | If it is impossible for You to comply with any of the terms of this
223 | License with respect to some or all of the Covered Software due to
224 | statute, judicial order, or regulation then You must: (a) comply with
225 | the terms of this License to the maximum extent possible; and (b)
226 | describe the limitations and the code they affect. Such description must
227 | be placed in a text file included with all distributions of the Covered
228 | Software under this License. Except to the extent prohibited by statute
229 | or regulation, such description must be sufficiently detailed for a
230 | recipient of ordinary skill to be able to understand it.
231 | 
232 | 5. Termination
233 | --------------
234 | 
235 | 5.1. The rights granted under this License will terminate automatically
236 | if You fail to comply with any of its terms. However, if You become
237 | compliant, then the rights granted under this License from a particular
238 | Contributor are reinstated (a) provisionally, unless and until such
239 | Contributor explicitly and finally terminates Your grants, and (b) on an
240 | ongoing basis, if such Contributor fails to notify You of the
241 | non-compliance by some reasonable means prior to 60 days after You have
242 | come back into compliance. Moreover, Your grants from a particular
243 | Contributor are reinstated on an ongoing basis if such Contributor
244 | notifies You of the non-compliance by some reasonable means, this is the
245 | first time You have received notice of non-compliance with this License
246 | from such Contributor, and You become compliant prior to 30 days after
247 | Your receipt of the notice.
248 | 
249 | 5.2. If You initiate litigation against any entity by asserting a patent
250 | infringement claim (excluding declaratory judgment actions,
251 | counter-claims, and cross-claims) alleging that a Contributor Version
252 | directly or indirectly infringes any patent, then the rights granted to
253 | You by any and all Contributors for the Covered Software under Section
254 | 2.1 of this License shall terminate.
255 | 
256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257 | end user license agreements (excluding distributors and resellers) which
258 | have been validly granted by You or Your distributors under this License
259 | prior to termination shall survive termination.
260 | 
261 | ************************************************************************
262 | *                                                                      *
263 | *  6. Disclaimer of Warranty                                           *
264 | *  -------------------------                                           *
265 | *                                                                      *
266 | *  Covered Software is provided under this License on an "as is"       *
267 | *  basis, without warranty of any kind, either expressed, implied, or  *
268 | *  statutory, including, without limitation, warranties that the       *
269 | *  Covered Software is free of defects, merchantable, fit for a        *
270 | *  particular purpose or non-infringing. The entire risk as to the     *
271 | *  quality and performance of the Covered Software is with You.        *
272 | *  Should any Covered Software prove defective in any respect, You     *
273 | *  (not any Contributor) assume the cost of any necessary servicing,   *
274 | *  repair, or correction. This disclaimer of warranty constitutes an   *
275 | *  essential part of this License. No use of any Covered Software is   *
276 | *  authorized under this License except under this disclaimer.         *
277 | *                                                                      *
278 | ************************************************************************
279 | 
280 | ************************************************************************
281 | *                                                                      *
282 | *  7. Limitation of Liability                                          *
283 | *  --------------------------                                          *
284 | *                                                                      *
285 | *  Under no circumstances and under no legal theory, whether tort      *
286 | *  (including negligence), contract, or otherwise, shall any           *
287 | *  Contributor, or anyone who distributes Covered Software as          *
288 | *  permitted above, be liable to You for any direct, indirect,         *
289 | *  special, incidental, or consequential damages of any character      *
290 | *  including, without limitation, damages for lost profits, loss of    *
291 | *  goodwill, work stoppage, computer failure or malfunction, or any    *
292 | *  and all other commercial damages or losses, even if such party      *
293 | *  shall have been informed of the possibility of such damages. This   *
294 | *  limitation of liability shall not apply to liability for death or   *
295 | *  personal injury resulting from such party's negligence to the       *
296 | *  extent applicable law prohibits such limitation. Some               *
297 | *  jurisdictions do not allow the exclusion or limitation of           *
298 | *  incidental or consequential damages, so this exclusion and          *
299 | *  limitation may not apply to You.                                    *
300 | *                                                                      *
301 | ************************************************************************
302 | 
303 | 8. Litigation
304 | -------------
305 | 
306 | Any litigation relating to this License may be brought only in the
307 | courts of a jurisdiction where the defendant maintains its principal
308 | place of business and such litigation shall be governed by laws of that
309 | jurisdiction, without reference to its conflict-of-law provisions.
310 | Nothing in this Section shall prevent a party's ability to bring
311 | cross-claims or counter-claims.
312 | 
313 | 9. Miscellaneous
314 | ----------------
315 | 
316 | This License represents the complete agreement concerning the subject
317 | matter hereof. If any provision of this License is held to be
318 | unenforceable, such provision shall be reformed only to the extent
319 | necessary to make it enforceable. Any law or regulation which provides
320 | that the language of a contract shall be construed against the drafter
321 | shall not be used to construe this License against a Contributor.
322 | 
323 | 10. Versions of the License
324 | ---------------------------
325 | 
326 | 10.1. New Versions
327 | 
328 | Mozilla Foundation is the license steward. Except as provided in Section
329 | 10.3, no one other than the license steward has the right to modify or
330 | publish new versions of this License. Each version will be given a
331 | distinguishing version number.
332 | 
333 | 10.2. Effect of New Versions
334 | 
335 | You may distribute the Covered Software under the terms of the version
336 | of the License under which You originally received the Covered Software,
337 | or under the terms of any subsequent version published by the license
338 | steward.
339 | 
340 | 10.3. Modified Versions
341 | 
342 | If you create software not governed by this License, and you want to
343 | create a new license for such software, you may create and use a
344 | modified version of this License if you rename the license and remove
345 | any references to the name of the license steward (except to note that
346 | such modified license differs from this License).
347 | 
348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary
349 | Licenses
350 | 
351 | If You choose to distribute Source Code Form that is Incompatible With
352 | Secondary Licenses under the terms of this version of the License, the
353 | notice described in Exhibit B of this License must be attached.
354 | 
355 | Exhibit A - Source Code Form License Notice
356 | -------------------------------------------
357 | 
358 |   This Source Code Form is subject to the terms of the Mozilla Public
359 |   License, v. 2.0. If a copy of the MPL was not distributed with this
360 |   file, You can obtain one at http://mozilla.org/MPL/2.0/.
361 | 
362 | If it is not possible or desirable to put the notice in a particular
363 | file, then You may include the notice in a location (such as a LICENSE
364 | file in a relevant directory) where a recipient would be likely to look
365 | for such a notice.
366 | 
367 | You may add additional accurate notices of copyright ownership.
368 | 
369 | Exhibit B - "Incompatible With Secondary Licenses" Notice
370 | ---------------------------------------------------------
371 | 
372 |   This Source Code Form is "Incompatible With Secondary Licenses", as
373 |   defined by the Mozilla Public License, v. 2.0.
374 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # LeetCode QuickAdd Script for Obsidian
  2 | 
  3 | ## Table of Contents
  4 | - [Introduction](#introduction)
  5 | - [Features](#features)
  6 | - [Screenshots](#screenshots)
  7 | - [Prerequisites](#prerequisites)
  8 | - [Installation](#installation)
  9 | - [Usage](#usage)
 10 | - [Configuration](#configuration)
 11 | - [How It Works](#how-it-works)
 12 | - [Limitations](#limitations)
 13 | - [License](#license)
 14 | - [Acknowledgements](#acknowledgements)
 15 | 
 16 | ## Introduction
 17 | 
 18 | The LeetCode QuickAdd Script is an Obsidian plugin script designed to more seamlessly integrate LeetCode problem information into your Obsidian vault. This script leverages the [QuickAdd](https://github.com/chhoumann/quickadd) plugin and a [LeetCode API](https://github.com/alfaarghya/alfa-leetcode-api) to fetch problem details and format them into a structured note, making it easier for users to track their LeetCode progress and study efficiently within Obsidian.
 19 | 
 20 | This is my first little coding project :) It aims to streamline the process of documenting LeetCode problems, allowing users to focus on problem-solving rather than manual note-taking.
 21 | 
 22 | 
 23 | 
 24 | ## Features
 25 | 
 26 | - Fetch LeetCode problem details using the problem's URL or title slug
 27 | - Automatically format problem statements, examples, constraints, and follow-up questions
 28 | - Convert HTML content to Markdown for better compatibility with Obsidian
 29 | - Create structured notes with problem metadata, including difficulty and tags
 30 | - Format examples as collapsible callouts for better organization
 31 | - Include formatted hints as hidden callouts
 32 | - Customize tag prefixes for better integration with your existing tag system
 33 | 
 34 | ## Screenshots
 35 | 
 36 | Auto populated properties
 37 | 
 38 | ![Screenshot of script-generated properies field](docs/Screenshots/autogen-properties-screenshot.png)
 39 | 
 40 | Sample Output
 41 | 
 42 | ![Screenshot of script-generated problem text field](docs/Screenshots/autogen-problem-screenshot.png)
 43 | 
 44 | Some support for more complex questions
 45 | 
 46 | ![Screenshot of script-generated image in example callout](docs/Screenshots/image-in-example-screenshot.png)
 47 | 
 48 | ## Prerequisites
 49 | 
 50 | Before using this script, ensure you have the following:
 51 | 
 52 | 1. [Obsidian](https://obsidian.md/) installed on your device
 53 | 2. The [QuickAdd plugin](https://github.com/chhoumann/quickadd) installed and enabled in your Obsidian vault
 54 | 
 55 | ## Installation
 56 | 
 57 | 1. In your Obsidian vault, create a new folder named `scripts` (if it doesn't already exist)
 58 | 2. Save `leetcode-quickadd.js` in the `scripts` folder
 59 | 3. Open the QuickAdd plugin settings in Obsidian
 60 | 4. Create a new Macro and add a "User Script" choice
 61 | 5. Select the `leetcode-quickadd.js` file as the script for this choice
 62 | 6. Add a page template for your Macro to use. See my personal example [below](#using-variables-in-your-template) for reference
 63 | 7. Configure the Macro settings as desired (e.g., output folder for LeetCode notes)
 64 | 
 65 | ## Usage
 66 | 
 67 | 1. Trigger the QuickAdd menu in Obsidian
 68 | 2. Select the LeetCode QuickAdd Macro you created
 69 | 3. Enter the URL or title slug of the LeetCode problem when prompted   
 70 | 4. The script will fetch the problem details and create a new note with the formatted information
 71 | 
 72 | ## Configuration
 73 | 
 74 | You can customize the script behavior by modifying the following settings in the QuickAdd Macro configuration:
 75 | 
 76 | - **LeetCode Tag Prefix**: Set a prefix for LeetCode problem/tags (default: "leetcode/")
 77 | >[!TIP]
 78 | >To change these settings:
 79 | >1. Open the QuickAdd plugin settings
 80 | >2. Edit the Macro you created for the LeetCode QuickAdd script
 81 | >3. Modify the values in the "User Script" choice settings
 82 | 
 83 | ## How It Works
 84 | 1. The script prompts the user for a LeetCode problem title slug
 85 | 2. It sends a request to the LeetCode API to fetch problem details
 86 | 3. The received HTML content is converted to Markdown
 87 | 4. Problem information is formatted into a structured note, including:
 88 |    - Problem title and ID
 89 |    - Difficulty
 90 |    - LeetCode problem link
 91 |    - Problem statement
 92 |    - Examples (as expanded callouts)
 93 |    - Constraints (as a callout)
 94 |    - Follow-up questions (as a hidden callout)
 95 |    - Tags (with customizable prefix)
 96 |    - Hints (as hidden callouts)
 97 | 5. The formatted note is created in the specified Obsidian folder
 98 | 
 99 | ## Template Variables
100 | 
101 | The LeetCode QuickAdd script provides several variables that you can use in your note templates. These variables are populated with data fetched from the LeetCode API. Here's a list of currently available variables and their descriptions:
102 | 
103 | | Variable | Description | Example |
104 | |----------|-------------|---------|
105 | | `{{VALUE:id}}` | The LeetCode problem ID | `1` |
106 | | `{{VALUE:title}}` | The title of the problem | `"Two Sum"` |
107 | | `{{VALUE:difficulty}}` | The difficulty level of the problem | `"Easy"` |
108 | | `{{VALUE:link}}` | The URL of the problem | `"https://leetcode.com/problems/two-sum"` |
109 | | `{{VALUE:problemStatement}}` | The full problem statement in Markdown format | (Markdown formatted text) |
110 | | `{{VALUE:tags}}` | A formatted list of problem tags with customizable prefix | `- leetcode/array` |
111 | | `{{VALUE:fileName}}` | A sanitized filename for the note | `1. "Two Sum"` |
112 | | `{{VALUE:formattedHints}}` | Formatted hints as hidden callouts | (Markdown formatted hints) |
113 | 
114 | ### Using Variables in Your Template
115 | 
116 | To use these variables in your QuickAdd template, surround them with double curly braces. Here's my personal template:
117 | 
118 | ```markdown
119 | ---
120 | created: {{DATE}}
121 | modified: 
122 | completed: false
123 | leetcode-index: {{VALUE:id}} 
124 | link: {{VALUE:link}}
125 | difficulty: {{VALUE:difficulty}} 
126 | tags:
127 | {{VALUE:tags}} 
128 |    - programming/practice
129 |    - leetcode/problem
130 | ---
131 | # {{VALUE:title}}
132 | 
133 | ## Question
134 | {{VALUE:problemStatement}}
135 | ### Hints
136 | {{VALUE:formattedHints}}
137 | 
138 | ---
139 | ## Solution
140 | 
141 | ### Intuition
142 | <!--Describe your first thoughts on how to solve this problem -->
143 | 
144 | 
145 | ### Approach
146 | <!-- Describe your approach to solving the problem. -->
147 | 
148 | 
149 | ### Complexity
150 | 
151 | #### Time complexity
152 | 
153 | 
154 | #### Space complexity
155 | 
156 | 
157 | ### Code
158 | ---
159 | ```
160 | Effective tagging and the [Dataview Plugin](https://github.com/blacksmithgu/obsidian-dataview) allow for some cool tracking and filtering of the problems. Check it out:
161 | 
162 | ![dataview](docs/Screenshots/dataview-effective-tagging.png)
163 | 
164 | ## Limitations
165 | 
166 | - Currently untested on mobile
167 | - Due to the large varience in Leetcode questions it sometimes has small formatting issue, particularly with examples and constraints. 
168 | - Probably many more!
169 | 
170 | 
171 | ## License
172 | 
173 | This project is licensed under the MPL-2 License - see the [LICENSE](LICENSE) file for details.
174 | 
175 | ## Acknowledgements
176 | 
177 | - [QuickAdd plugin](https://github.com/chhoumann/quickadd) by Christian B. B. Houmann
178 | - [Alfa Leetcode](https://github.com/alfaarghya/alfa-leetcode-api) by Arghya Das
179 | - [LeetCode](https://leetcode.com/) for providing so many problems 
180 | - [Obsidian](https://obsidian.md/) for the amazing note-taking app
181 | 
182 | ---
183 | 
184 | If you find this script helpful, consider starring the repository and sharing it with others!
185 | Thanks!  Shane Z :)
186 | 


--------------------------------------------------------------------------------
/Scripts/leetcode-quickadd.js:
--------------------------------------------------------------------------------
  1 | /**
  2 |  * LeetCode Problem Fetcher for Obsidian
  3 |  * 
  4 |  * This script fetches problem data from LeetCode using an API and formats it for use in Obsidian notes.
  5 |  * It's designed to work with the QuickAdd plugin for Obsidian.
  6 |  */
  7 | 
  8 | // Utility functions for notifications and logging
  9 | const notice = msg => new Notice(msg, 5000);
 10 | const log = msg => console.log(msg);
 11 | 
 12 | // Constants
 13 | const API_URL = "https://alfa-leetcode-api.onrender.com/select";
 14 | // const API_URL = "http://localhost:3000/select";
 15 | const TAG_PREFIX_SETTING = "LeetCode Tag Prefix";
 16 | 
 17 | // QuickAdd module configuration
 18 | module.exports = {
 19 |     entry: start,
 20 |     settings: {
 21 |         name: "LeetCode Puller",
 22 |         author: "Shane Zimmerman",
 23 |         options: {
 24 |             [TAG_PREFIX_SETTING]: {
 25 |                 type: "text",
 26 |                 defaultValue: "leetcode/",
 27 |                 placeholder: "Enter tag prefix (e.g., leetcode/)",
 28 |                 description: "Prefix to be added to LeetCode tags.",
 29 |             }
 30 |         }
 31 |     }
 32 | }
 33 | 
 34 | // Global variables to store QuickAdd API and settings
 35 | let QuickAdd;
 36 | let Settings;
 37 | 
 38 | /**
 39 |  * Main entry point for the script
 40 |  * @param {Object} params - QuickAdd parameters
 41 |  * @param {Object} settings - User-defined settings
 42 |  */
 43 | async function start(params, settings) {
 44 |     QuickAdd = params;
 45 |     Settings = settings;
 46 | 
 47 |     const input = await promptForInput();
 48 |     if (!input) return;
 49 | 
 50 |     const titleSlug = extractTitleSlug(input);
 51 |     if (!titleSlug) return;
 52 | 
 53 |     const problemData = await getLeetCodeProblem(titleSlug);
 54 |     if (!problemData) return;
 55 | 
 56 |     setQuickAddVariables(problemData);
 57 | }
 58 | 
 59 | /**
 60 |  * Prompts the user for a LeetCode problem title slug or URL
 61 |  * @returns {string|null} The entered input or null if cancelled
 62 |  */
 63 | async function promptForInput() {
 64 |     const input = await QuickAdd.quickAddApi.inputPrompt("Enter LeetCode problem title slug or URL:");
 65 |     if (!input) {
 66 |         notice("No input entered.");
 67 |         return null;
 68 |     }
 69 |     return input;
 70 | }
 71 | 
 72 | /**
 73 |  * Extracts the title slug from the input (URL or title slug)
 74 |  * @param {string} input - The user input (URL or title slug)
 75 |  * @returns {string|null} The extracted title slug or null if invalid
 76 |  */
 77 | function extractTitleSlug(input) {
 78 |     // Check if the input is a URL
 79 |     if (input.startsWith('http://') || input.startsWith('https://')) {
 80 |         const url = new URL(input);
 81 |         const pathParts = url.pathname.split('/');
 82 |         const problemsIndex = pathParts.indexOf('problems');
 83 |         if (problemsIndex !== -1 && problemsIndex < pathParts.length - 1) {
 84 |             return pathParts[problemsIndex + 1];
 85 |         } else {
 86 |             notice("Invalid LeetCode URL. Unable to extract title slug.");
 87 |             return null;
 88 |         }
 89 |     }
 90 |     // If not a URL, assume it's already a title slug
 91 |     return input;
 92 | }
 93 | 
 94 | /**
 95 |  * Fetches problem data from the LeetCode API
 96 |  * @param {string} titleSlug - The title slug of the LeetCode problem
 97 |  * @returns {Object|null} Problem data object or null if fetching failed
 98 |  */
 99 | async function getLeetCodeProblem(titleSlug) {
100 |     try {
101 |         const response = await request({
102 |             url: `${API_URL}?titleSlug=${titleSlug}`,
103 |             method: 'GET',
104 |             cache: 'no-cache',
105 |             headers: {
106 |                 'Content-Type': 'application/json',
107 |             },
108 |         });
109 | 
110 |         const data = JSON.parse(response);
111 |         log("API Response:", JSON.stringify(data, null, 2));
112 | 
113 |         return {
114 |             id: data.questionFrontendId || "",
115 |             title: data.questionTitle || "",
116 |             difficulty: data.difficulty || "",
117 |             link: data.link || `https://leetcode.com/problems/${titleSlug}`,
118 |             topicTags: data.topicTags || [],
119 |             problemStatement: formatProblemStatement(data.question || ""),
120 |             hints: data.hints || [],
121 |         };
122 |     } catch (error) {
123 |         console.error('Error fetching LeetCode problem:', error);
124 |         notice("Failed to fetch problem data.");
125 |         return null;
126 |     }
127 | }
128 | 
129 | /**
130 |  * Sets QuickAdd variables with the fetched problem data
131 |  * @param {Object} problemData - The fetched problem data
132 |  */
133 | function setQuickAddVariables(problemData) {
134 |     QuickAdd.variables = {
135 |         ...problemData,
136 |         fileName: `${problemData.id}. ${replaceIllegalFileNameCharactersInString(problemData.title)}`,
137 |         difficultyLink: `[[${problemData.difficulty}]]`,
138 |         tags: formatTags(problemData.topicTags),
139 |         formattedHints: formatHints(problemData.hints),
140 |     };
141 | }
142 | 
143 | /**
144 |  * Formats the problem statement HTML into Markdown
145 |  * @param {string} html - The HTML problem statement
146 |  * @returns {string} Formatted Markdown problem statement
147 |  */
148 | function formatProblemStatement(html) {
149 |     if (!html) return "";
150 |     
151 |     let markdown = convertHtmlToMarkdown(html);
152 |     markdown = formatExamples(markdown);
153 |     markdown = formatConstraints(markdown);
154 |     markdown = formatFollowUp(markdown);
155 | 
156 |     return markdown.replace(/\n{3,}/g, '\n\n').replace(/`+$/gm, '`').trim();
157 | }
158 | 
159 | /**
160 |  * Converts HTML to Markdown
161 |  * @param {string} html - The HTML to convert
162 |  * @returns {string} Converted Markdown
163 |  */
164 | function convertHtmlToMarkdown(html) {
165 |     let markdown = html
166 |         .replace(/<p>/g, '\n\n')
167 |         .replace(/<\/p>/g, '')
168 |         .replace(/<code>/g, '`')
169 |         .replace(/<\/code>/g, '`')
170 |         .replace(/<em>/g, '*')
171 |         .replace(/<\/em>/g, '*')
172 |         .replace(/<strong[^>]*>/g, '')
173 |         .replace(/<\/strong>/g, '')
174 |         .replace(/<pre>/g, '`')
175 |         .replace(/<\/pre>/g, '`')
176 |         .replace(/<sup>(.*?)<\/sup>/g, '^$1')
177 |         .replace(/<font[^>]*>/g, '')
178 |         .replace(/<\/font>/g, '')
179 |         .replace(/&nbsp;/g, ' ')
180 |         .replace(/&lt;/g, '<')
181 |         .replace(/&gt;/g, '>')
182 |         .replace(/&amp;/g, '&')
183 |         .replace(/&#39;/g,'\'')
184 |         .replace(/<img[^>]*src="([^"]*)"[^>]*>/g, '![]($1)')
185 |         .replace(/<span class="example-io">(.*?)<\/span>/g, '$1')
186 |         .replace(/&quot;/g,'"');
187 | 
188 |     return formatLists(markdown);
189 | }
190 | 
191 | /**
192 |  * Formats HTML lists into Markdown lists
193 |  * @param {string} markdown - The Markdown to format
194 |  * @returns {string} Markdown with formatted lists
195 |  */
196 | function formatLists(markdown) {
197 |     let listStack = [];
198 |     let listItemNumber = {};
199 | 
200 |     return markdown.replace(/<\/?(?:ul|ol|li)>/g, (match, offset, string) => {
201 |         switch (match) {
202 |             case '<ul>':
203 |                 listStack.push('ul');
204 |                 return '\n';
205 |             case '<ol>':
206 |                 listStack.push('ol');
207 |                 listItemNumber[listStack.length] = 1;
208 |                 return '\n';
209 |             case '</ul>':
210 |             case '</ol>':
211 |                 listStack.pop();
212 |                 return '\n';
213 |             case '<li>':
214 |                 let indent = '  '.repeat(listStack.length - 1);
215 |                 if (listStack[listStack.length - 1] === 'ul') {
216 |                     return `\n${indent}- `;
217 |                 } else {
218 |                     let number = listItemNumber[listStack.length];
219 |                     listItemNumber[listStack.length]++;
220 |                     return `\n${indent}${number}. `;
221 |                 }
222 |             case '</li>':
223 |                 return '';
224 |         }
225 |     });
226 | }
227 | 
228 | /**
229 |  * Formats examples in the problem statement
230 |  * @param {string} markdown - The Markdown to format
231 |  * @returns {string} Markdown with formatted examples
232 |  */
233 | function formatExamples(markdown) {
234 |     // console.log(markdown); 
235 |     let exampleCount = 1;
236 |     return markdown.replace(/Example \d+:([\s\S]*?)(?=Example \d+:|Constraints:|Follow-up:|$)/g, (match, content) => {
237 |         const imageMatch = content.match(/!\[.*?\]\((.*?)\)/);
238 |         const inputMatch = content.match(/Input:.*?([\s\S]*?)(?=<\/div>|Output|$)/i);
239 |         const outputMatch = content.match(/Output:.*?([\s\S]*?)(?=<\/div>|Explanation|$)/i);
240 |         const explanationMatch = content.match(/Explanation:.*?([\s\S]*)/i); 
241 | 
242 |         let formattedExample = `>[!Example]+ Example ${exampleCount}\n`;
243 |         if (imageMatch) {
244 |             formattedExample += `>![](${imageMatch[1]})\n>\n`;
245 |         }
246 |         if (inputMatch) {
247 |             formattedExample += `>**Input**: \`${inputMatch[1].trim()}\`\n`;
248 |         }
249 |         if (outputMatch) {
250 |             formattedExample += `>**Output**: \`${outputMatch[1].trim()}\`\n`;
251 |         }
252 |         if (explanationMatch) {
253 |             let explanation = explanationMatch[1]
254 |                 .trim()
255 |                 .replace(/<\/?div>/g, '') 
256 |                 .replace(/`$/, '') 
257 |                 .replace(/\n/g, ' ') 
258 |                 .replace(/(\d+\))\s?/g, '\n> $1 '); 
259 | 
260 |             formattedExample += `>**Explanation**:\n>${explanation}\n`;
261 |         }
262 | 
263 |         exampleCount++;
264 |         return formattedExample + '\n';
265 |     });
266 | }
267 | 
268 | /**
269 |  * Formats constraints in the problem statement
270 |  * @param {string} markdown - The Markdown to format
271 |  * @returns {string} Markdown with formatted constraints
272 |  */
273 | function formatConstraints(markdown) {
274 |     const constraintsMatch = markdown.match(/Constraints:([\s\S]*?)(?=Follow-up:|$)/);
275 |     if (constraintsMatch) {
276 |         const constraintsContent = constraintsMatch[1].trim().split('\n').map(line => '>' + line.trim()).join('\n');
277 |         return markdown.replace(/Constraints:[\s\S]*?(?=Follow-up:|$)/, `>[!warning]+ Constraints\n${constraintsContent}\n\n`);
278 |     }
279 |     return markdown;
280 | }
281 | 
282 | /**
283 |  * Formats follow-up section in the problem statement
284 |  * @param {string} markdown - The Markdown to format
285 |  * @returns {string} Markdown with formatted follow-up section
286 |  */
287 | function formatFollowUp(markdown) {
288 |     const followUpMatch = markdown.match(/Follow-up:([\s\S]*?)$/);
289 |     if (followUpMatch) {
290 |         const followUpContent = followUpMatch[1].trim();
291 |         return markdown.replace(/Follow-up:[\s\S]*$/, `>[!Todo]- Follow Up\n>${followUpContent}\n`);
292 |     }
293 |     return markdown;
294 | }
295 | 
296 | /**
297 |  * Formats tags for the problem
298 |  * @param {Array} tags - Array of tag objects
299 |  * @returns {string} Formatted tag string
300 |  */
301 | function formatTags(tags) {
302 |     if (!tags || !Array.isArray(tags)) return "";
303 |     const prefix = Settings[TAG_PREFIX_SETTING] || "";
304 |     return tags.map(tag => `   - ${prefix}${tag.slug.trim()}`).join('\n');
305 | }
306 | 
307 | /**
308 |  * Formats hints for the problem
309 |  * @param {Array} hints - Array of hint strings
310 |  * @returns {string} Formatted hints string
311 |  */
312 | function formatHints(hints) {
313 |     if (!hints || hints.length === 0) return "No hints available.";
314 |     return hints.map((hint, index) => `>[!Hint]- Hint ${index + 1}\n>${stripHtmlTags(hint).replace(/\n/g, '\n>')}`).join("\n\n");
315 | }
316 | 
317 | /**
318 |  * Strips HTML tags from a string
319 |  * @param {string} html - The HTML string to strip
320 |  * @returns {string} String without HTML tags
321 |  */
322 | function stripHtmlTags(html) {
323 |     return html ? html.replace(/<[^>]*>/g, '') : "";
324 | }
325 | 
326 | /**
327 |  * Replaces illegal characters in a filename
328 |  * @param {string} string - The string to process
329 |  * @returns {string} String with illegal characters removed
330 |  */
331 | function replaceIllegalFileNameCharactersInString(string) {
332 |     return string ? string.replace(/[\\,#%&{}/*<>$'":@]/g, '') : "";
333 | }


--------------------------------------------------------------------------------
/Templates/leetcode-problem-template.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | created: {{DATE}}
 3 | modified: 
 4 | completed: false
 5 | leetcode-index: {{VALUE:id}} 
 6 | link: {{VALUE:link}}
 7 | difficulty: {{VALUE:difficulty}} 
 8 | tags:
 9 | {{VALUE:tags}} 
10 |    - programming/practice
11 |    - leetcode/problem
12 |    - your/tags
13 | ---
14 | # {{VALUE:title}}
15 | 
16 | ## Problem Statement
17 | {{VALUE:problemStatement}}
18 | ## Hints
19 | {{VALUE:formattedHints}}
20 | ## Approach
21 | 
22 | - 
23 | ## Solution
24 | 
25 | ```python
26 | # Solution
27 | ```
28 | 
29 | ## Complexity Analysis
30 | 
31 | - Time complexity: 
32 | - Space complexity: 
33 | 
34 | ## Reflections
35 | - 


--------------------------------------------------------------------------------
/docs/Screenshots/autogen-problem-screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/zimmshane/leetcode-puller-obsidian/a7a4d66d7ef43d5a7a050f54c4d0c2de380b7ab7/docs/Screenshots/autogen-problem-screenshot.png


--------------------------------------------------------------------------------
/docs/Screenshots/autogen-properties-screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/zimmshane/leetcode-puller-obsidian/a7a4d66d7ef43d5a7a050f54c4d0c2de380b7ab7/docs/Screenshots/autogen-properties-screenshot.png


--------------------------------------------------------------------------------
/docs/Screenshots/dataview-effective-tagging.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/zimmshane/leetcode-puller-obsidian/a7a4d66d7ef43d5a7a050f54c4d0c2de380b7ab7/docs/Screenshots/dataview-effective-tagging.png


--------------------------------------------------------------------------------
/docs/Screenshots/image-in-example-screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/zimmshane/leetcode-puller-obsidian/a7a4d66d7ef43d5a7a050f54c4d0c2de380b7ab7/docs/Screenshots/image-in-example-screenshot.png


--------------------------------------------------------------------------------
/docs/Screenshots/problem-search-screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/zimmshane/leetcode-puller-obsidian/a7a4d66d7ef43d5a7a050f54c4d0c2de380b7ab7/docs/Screenshots/problem-search-screenshot.png


--------------------------------------------------------------------------------