├── .editorconfig ├── .eslintignore ├── .eslintrc ├── .github └── workflows │ └── release.yml ├── .gitignore ├── LICENSE ├── README.md ├── esbuild.config.mjs ├── manifest.json ├── package.json ├── src ├── main.ts ├── modals │ └── new_entry_modal.ts ├── para │ └── project.ts ├── para_types.ts └── settings │ ├── settings.ts │ └── settings_tab.ts ├── styles.css ├── tsconfig.json └── versions.json /.editorconfig: -------------------------------------------------------------------------------- 1 | # top-most EditorConfig file 2 | root = true 3 | 4 | [*] 5 | charset = utf-8 6 | insert_final_newline = true 7 | indent_style = tab 8 | indent_size = 4 9 | tab_width = 4 10 | -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | npm node_modules 2 | build -------------------------------------------------------------------------------- /.eslintrc: -------------------------------------------------------------------------------- 1 | { 2 | "root": true, 3 | "parser": "@typescript-eslint/parser", 4 | "plugins": [ 5 | "@typescript-eslint" 6 | ], 7 | "extends": [ 8 | "eslint:recommended", 9 | "plugin:@typescript-eslint/eslint-recommended", 10 | "plugin:@typescript-eslint/recommended" 11 | ], 12 | "parserOptions": { 13 | "sourceType": "module" 14 | }, 15 | "rules": { 16 | "no-unused-vars": "off", 17 | "@typescript-eslint/no-unused-vars": ["error", { "args": "none" }], 18 | "@typescript-eslint/ban-ts-comment": "off", 19 | "no-prototype-builtins": "off", 20 | "@typescript-eslint/no-empty-function": "off" 21 | } 22 | } -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release Obsidian plugin 2 | 3 | on: 4 | push: 5 | tags: 6 | - "*" 7 | 8 | env: 9 | PLUGIN_NAME: para-shortcuts # Change this to match the id of your plugin. 10 | 11 | jobs: 12 | build: 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - uses: actions/checkout@v2 17 | - name: Use Node.js 18 | uses: actions/setup-node@v1 19 | with: 20 | node-version: "14.x" 21 | 22 | - name: Build 23 | id: build 24 | run: | 25 | npm install 26 | npm run build 27 | mkdir ${{ env.PLUGIN_NAME }} 28 | cp main.js manifest.json styles.css ${{ env.PLUGIN_NAME }} 29 | zip -r ${{ env.PLUGIN_NAME }}.zip ${{ env.PLUGIN_NAME }} 30 | ls 31 | echo "::set-output name=tag_name::$(git tag --sort version:refname | tail -n 1)" 32 | 33 | - name: Create Release 34 | id: create_release 35 | uses: actions/create-release@v1 36 | env: 37 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 38 | VERSION: ${{ github.ref }} 39 | with: 40 | tag_name: ${{ github.ref }} 41 | release_name: ${{ github.ref }} 42 | draft: false 43 | prerelease: false 44 | 45 | - name: Upload zip file 46 | id: upload-zip 47 | uses: actions/upload-release-asset@v1 48 | env: 49 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 50 | with: 51 | upload_url: ${{ steps.create_release.outputs.upload_url }} 52 | asset_path: ./${{ env.PLUGIN_NAME }}.zip 53 | asset_name: ${{ env.PLUGIN_NAME }}-${{ steps.build.outputs.tag_name }}.zip 54 | asset_content_type: application/zip 55 | 56 | - name: Upload main.js 57 | id: upload-main 58 | uses: actions/upload-release-asset@v1 59 | env: 60 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 61 | with: 62 | upload_url: ${{ steps.create_release.outputs.upload_url }} 63 | asset_path: ./main.js 64 | asset_name: main.js 65 | asset_content_type: text/javascript 66 | 67 | - name: Upload manifest.json 68 | id: upload-manifest 69 | uses: actions/upload-release-asset@v1 70 | env: 71 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 72 | with: 73 | upload_url: ${{ steps.create_release.outputs.upload_url }} 74 | asset_path: ./manifest.json 75 | asset_name: manifest.json 76 | asset_content_type: application/json 77 | 78 | - name: Upload styles.css 79 | id: upload-css 80 | uses: actions/upload-release-asset@v1 81 | env: 82 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 83 | with: 84 | upload_url: ${{ steps.create_release.outputs.upload_url }} 85 | asset_path: ./styles.css 86 | asset_name: styles.css 87 | asset_content_type: text/css -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # vscode 2 | .vscode 3 | 4 | # Intellij 5 | *.iml 6 | .idea 7 | 8 | # npm 9 | node_modules 10 | package-lock.json 11 | 12 | # Don't include the compiled main.js file in the repo. 13 | # They should be uploaded to GitHub releases instead. 14 | main.js 15 | 16 | # Exclude sourcemaps 17 | *.map 18 | 19 | # obsidian 20 | data.json 21 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # para-shortcuts 2 | 3 | This plugin serves useful commands to set up and manage your knowledge using the PARA method. 4 | 5 | ## The PARA Method 6 | A full article on the PARA method and its benefits can be found on this [blog post](https://fortelabs.co/blog/para/) by Tiago Forte. 7 | 8 | Brief summery of the PARA folder structure: 9 | - **Projects**: A project is "a series of tasks linked to a goal, with a deadline". 10 | - **Area**: An area of responsibility is "a sphere of activity with a standard to be maintained over time". 11 | - **Resource**: A resource is "a topic or theme of ongoing interest". 12 | - **Archive**: Archives include "inactive items from the other three categories". 13 | 14 | Additional: Put personally relevant information in Areas, and generally useful information in Resources. 15 | ## Commands 16 | 17 | All commands can be accessed in the command palette. 18 | Default: `CTRL+p` 19 | 20 | Overview: 21 | - [Init Vault](init-vault) 22 | - [Create new entry](create-new-entry) 23 | - [Move to archive](move-to-archive) 24 | - [Restore entry from archive](restore-entry-from-archive) 25 | - [Postpone an entry](postpone-an-entry) 26 | 27 | ### Init Vault 28 | Para follows a simple folder structure to organize your knowledge. 29 | This command creates the folders accordingly in the root of the vault. 30 | 31 | ### Create new entry 32 | Create a new entry in the markdown file with a basic template in the selected folder. 33 | 34 | ### Move to archive 35 | Moves the currently opened file in its respective folder in the archive. 36 | This command creates the matching para folder and subfolders if not present. 37 | Note that this command is only present in not 'archive'-folders. 38 | 39 | ### Restore entry from archive 40 | This command is only present for files in the 'archive'-folder. 41 | It restores the selected file back to its original PARA-folder with its subfolders. 42 | 43 | ### Postpone an entry 44 | You can postpone an entry with the 'postpone this entry'-command. 45 | The currently opened file will be move into a 'postponed' folder in the same para-folder. 46 | 47 | ### Reschedule a postponed entry 48 | An entry in a 'postponed'-folder can be restored by the 'Reschedule this entry'-command. 49 | If the remaining parent folder is empty it will be deleted. 50 | 51 | ## Further Improvements 52 | If you would like to see additional features in this plug-in, feel free to hand in a feature request in the issue section. 53 | 54 | ## Support 55 | Buy Me A Coffee 56 | -------------------------------------------------------------------------------- /esbuild.config.mjs: -------------------------------------------------------------------------------- 1 | import esbuild from "esbuild"; 2 | import process from "process"; 3 | import builtins from 'builtin-modules' 4 | 5 | const banner = 6 | `/* 7 | THIS IS A GENERATED/BUNDLED FILE BY ESBUILD 8 | if you want to view the source, please visit the github repository of this plugin 9 | */ 10 | `; 11 | 12 | const prod = (process.argv[2] === 'production'); 13 | 14 | esbuild.build({ 15 | banner: { 16 | js: banner, 17 | }, 18 | entryPoints: ['main.ts'], 19 | bundle: true, 20 | external: ['obsidian', 'electron', ...builtins], 21 | format: 'cjs', 22 | watch: !prod, 23 | target: 'es2016', 24 | logLevel: "info", 25 | sourcemap: prod ? false : 'inline', 26 | treeShaking: true, 27 | outfile: 'main.js', 28 | }).catch(() => process.exit(1)); 29 | -------------------------------------------------------------------------------- /manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "para-shortcuts", 3 | "name": "PARA Shortcuts", 4 | "version": "1.0.6", 5 | "minAppVersion": "0.12.0", 6 | "description": "This plugin serves usefull commands to setup and manage your knowledge using the PARA method.", 7 | "author": "gOAT", 8 | "authorUrl": "https://github.com/gOATiful/para-shortcuts", 9 | "isDesktopOnly": false 10 | } 11 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "para-shortcuts", 3 | "version": "1.0.7", 4 | "description": "This plugin serves useful commands to setup and manage your knowledge using the PARA method.", 5 | "main": "main.js", 6 | "scripts": { 7 | "dev": "node esbuild.config.mjs", 8 | "build": "node esbuild.config.mjs production" 9 | }, 10 | "keywords": [ 11 | "obsidian-plugin", 12 | "PARA", 13 | "Knowledge management" 14 | ], 15 | "author": "gOAT", 16 | "license": "MIT", 17 | "devDependencies": { 18 | "@types/node": "^16.11.6", 19 | "@typescript-eslint/eslint-plugin": "^5.2.0", 20 | "@typescript-eslint/parser": "^5.2.0", 21 | "builtin-modules": "^3.2.0", 22 | "esbuild": "0.13.12", 23 | "obsidian": "^1.5.7-1", 24 | "tslib": "2.3.1", 25 | "typescript": "4.4.4" 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /src/main.ts: -------------------------------------------------------------------------------- 1 | import { 2 | moment, 3 | normalizePath, 4 | Notice, 5 | Plugin, 6 | TAbstractFile, 7 | TextFileView, 8 | TFolder, 9 | } from "obsidian"; 10 | 11 | import { Settings, DEFAULT_SETTINGS, settingsToMap } from "settings/settings"; 12 | import { ParaShortcutsSettingTab } from "settings/settings_tab"; 13 | import { CreateNewEntryModal } from "modals/new_entry_modal"; 14 | import { ParaType } from "para_types"; 15 | 16 | const DATE_FORMAT = "YYYY-MM-DD"; 17 | const POSTPONE_FOLDER_NAME = "postponed"; 18 | 19 | export default class ParaShortcutsPlugin extends Plugin { 20 | settings: Settings; 21 | private folderMapping: Map; 22 | 23 | async onload() { 24 | await this.loadSettings(); 25 | 26 | // This adds a simple command that can be triggered anywhere 27 | this.addCommand({ 28 | id: "create-new-entry", 29 | name: "Create new entry", 30 | callback: () => this.commandCreateNewEntry(), 31 | }); 32 | this.addCommand({ 33 | id: "init-vault", 34 | name: "Init vault with PARA folders", 35 | callback: () => this.commandInitPara(), 36 | }); 37 | this.addCommand({ 38 | id: "move-to-archive", 39 | name: "Move current file to archive", 40 | checkCallback: (checking: boolean) => 41 | this.commandMoveToArchive(checking), 42 | }); 43 | this.addCommand({ 44 | id: "restore-from-archive", 45 | name: "Restore entry from archive", 46 | checkCallback: (checking: boolean) => 47 | this.commandRestoreFromArchive(checking), 48 | }); 49 | this.addCommand({ 50 | id: "postpone-entry", 51 | name: "Postpone this entry", 52 | checkCallback: (checking: boolean) => 53 | this.commandPostponeEntry(checking), 54 | }); 55 | this.addCommand({ 56 | id: "reschedule-entry", 57 | name: "Reschedule this entry", 58 | checkCallback: (checking: boolean) => 59 | this.commandRescheduleEntry(checking), 60 | }); 61 | 62 | this.registerEvent( 63 | this.app.workspace.on("file-menu", (menu, file) => { 64 | if (this.canMoveToArchive(file)) { 65 | menu.addItem((item) => { 66 | item 67 | .setTitle("Move to archive") 68 | .onClick(() => { 69 | this.moveToArchive(file); 70 | }) 71 | }); 72 | } 73 | if (this.canRestoreFromArchive(file)) { 74 | menu.addItem((item) => { 75 | item 76 | .setTitle("Restore from archive") 77 | .onClick(() => { 78 | this.restoreFromArchive(file); 79 | }) 80 | }); 81 | } 82 | }) 83 | ); 84 | 85 | this.addSettingTab(new ParaShortcutsSettingTab(this.app, this)); 86 | } 87 | 88 | onunload() {} 89 | 90 | async loadSettings() { 91 | let loadedData = await this.loadData(); 92 | this.settings = Object.assign({}, DEFAULT_SETTINGS, loadedData); 93 | this.folderMapping = settingsToMap(this.settings); 94 | } 95 | 96 | async saveSettings() { 97 | await this.saveData(this.settings); 98 | this.folderMapping = settingsToMap(this.settings); 99 | } 100 | 101 | /** 102 | * Create a new File in the matching folder based on the given `type` 103 | * @param type specifies the folder in which the file will be created 104 | * @param filename the name of the created file 105 | */ 106 | public async createEntryByType(type: ParaType, filename = "untitled.md") { 107 | let folderName = this.folderMapping.get(type); 108 | let rootFolderChildren = this.app.vault.getRoot().children; 109 | let selectedFolder = rootFolderChildren.find( 110 | (ele) => ele.name === folderName 111 | ); 112 | if (selectedFolder !== undefined) { 113 | let filepath = normalizePath([folderName, filename].join("/")); 114 | let createdFile = await this.app.vault.create( 115 | filepath, 116 | this.createMetaHeader() 117 | ); 118 | await this.app.workspace.getLeaf().openFile( 119 | createdFile, 120 | {active: true} 121 | ); // open the created file 122 | } 123 | } 124 | 125 | private commandCreateNewEntry() { 126 | let modal = new CreateNewEntryModal(this.app, this); 127 | modal.open(); 128 | } 129 | 130 | private commandInitPara() { 131 | if (this.isParaVault()) { 132 | new Notice("PARA already initialized!"); 133 | return; 134 | } 135 | this.createParaFolders() 136 | .then(() => { 137 | new Notice("Vault successfuly initialized!"); 138 | }) 139 | .catch((_) => { 140 | new Notice("Error creating PARA folders"); 141 | }); 142 | } 143 | 144 | private canRestoreFromArchive(file: TAbstractFile): boolean { 145 | return this.isFolderInParaType(file.parent, ParaType.archive); 146 | } 147 | 148 | private restoreFromArchive(file: TAbstractFile): void { 149 | let archiveFolderName = this.folderMapping.get(ParaType.archive); 150 | let newFilePath = normalizePath(file.path.replace(archiveFolderName, "")); 151 | let folderToDelete = file.parent; 152 | this.moveFileAndCreateFolder(file, newFilePath) 153 | .then(() => { 154 | new Notice(`Restored file to ${newFilePath}`); 155 | this.deleteFolderIfEmpty(folderToDelete); 156 | }) 157 | .catch((_) => { 158 | new Notice(`Unable to resotre file`); 159 | }); 160 | } 161 | 162 | /** 163 | * Restores the open file back to its corresponding para folder 164 | * @param checking 165 | * @returns 166 | */ 167 | private commandRestoreFromArchive(checking: boolean): boolean | void { 168 | let activeFile = this.app.workspace.getActiveFile(); 169 | if (activeFile !== null) { 170 | if (checking) { 171 | // Command is only active if file is in archive folder 172 | return this.canRestoreFromArchive(activeFile); 173 | } 174 | this.restoreFromArchive(activeFile); 175 | } 176 | } 177 | 178 | /** 179 | * Moves out of the postponed into its original folder. 180 | * @param checking 181 | * @returns 182 | */ 183 | private commandRescheduleEntry(checking: boolean): boolean | void { 184 | let activeFile = this.app.workspace.getActiveFile(); 185 | if (activeFile !== null) { 186 | if (checking) { 187 | return ( 188 | !this.isFolderInParaType( 189 | activeFile.parent, 190 | ParaType.archive 191 | ) && activeFile.path?.contains(POSTPONE_FOLDER_NAME) 192 | ); 193 | } 194 | } 195 | let newFilePath = normalizePath( 196 | activeFile.path.replace(`/${POSTPONE_FOLDER_NAME}`, "") 197 | ); 198 | let folderToDelete = activeFile.parent; 199 | this.moveFileAndCreateFolder(activeFile, newFilePath) 200 | .then(() => { 201 | new Notice(`Rescheduled ${newFilePath}.`); 202 | this.deleteFolderIfEmpty(folderToDelete); 203 | }) 204 | .catch((_) => { 205 | new Notice(`Unable to move file to ${newFilePath}.`); 206 | }); 207 | } 208 | 209 | private commandPostponeEntry(checking: boolean): boolean | void { 210 | let activeFile = this.app.workspace.getActiveFile(); 211 | if (activeFile !== null) { 212 | if (checking) { 213 | return ( 214 | !this.isFolderInParaType( 215 | activeFile.parent, 216 | ParaType.archive 217 | ) && !activeFile.path?.contains(POSTPONE_FOLDER_NAME) 218 | ); 219 | } 220 | let paratype = this.findParaTypeInPath(activeFile.parent); 221 | if (paratype != null) { 222 | let foldername = this.folderMapping.get(paratype); 223 | let newFilePath = normalizePath( 224 | activeFile.path.replace( 225 | foldername, 226 | foldername + `/${POSTPONE_FOLDER_NAME}` 227 | ) 228 | ); 229 | let folderToDelete = activeFile.parent; 230 | this.moveFileAndCreateFolder(activeFile, newFilePath) 231 | .then(() => { 232 | new Notice(`Postponed ${newFilePath}.`); 233 | this.deleteFolderIfEmpty(folderToDelete); 234 | }) 235 | .catch((_) => { 236 | new Notice(`Unable to move file to ${newFilePath}.`); 237 | }); 238 | } 239 | } 240 | } 241 | 242 | private canMoveToArchive(file: TAbstractFile): boolean { 243 | return !this.isFolderInParaType(file.parent, ParaType.archive); 244 | } 245 | 246 | private moveToArchive(file: TAbstractFile): void { 247 | let archiveFolderName = this.folderMapping.get(ParaType.archive); 248 | let pathToFile = normalizePath( 249 | [ 250 | this.app.vault.getRoot().name, 251 | archiveFolderName, 252 | file.path, 253 | ].join("/") 254 | ); 255 | this.moveFileAndCreateFolder(file, pathToFile) 256 | .then(() => { 257 | new Notice(`Moved file to ${pathToFile}.`); 258 | }) 259 | .catch((_) => { 260 | new Notice(`Unable to move file to ${pathToFile}.`); 261 | }); 262 | } 263 | 264 | private commandMoveToArchive(checking: boolean): boolean | void { 265 | let activeFile = this.app.workspace.getActiveFile(); 266 | if (activeFile !== null) { 267 | if (checking) { 268 | return this.canMoveToArchive(activeFile); 269 | } 270 | this.moveToArchive(activeFile); 271 | } 272 | } 273 | 274 | private async moveFileAndCreateFolder( 275 | file: TAbstractFile, 276 | newPath: string 277 | ): Promise { 278 | try { 279 | await this.app.fileManager.renameFile(file, newPath); 280 | } catch (error) { 281 | // try to create folder and try again 282 | let pathToFolder = this.getDirName(newPath); 283 | await this.app.vault.createFolder(pathToFolder); 284 | await this.app.fileManager.renameFile(file, newPath); 285 | } 286 | } 287 | 288 | private isFolderInParaType(folder: TFolder, paraType: ParaType): boolean { 289 | let paraTypeOfFolder = this.findTopelevelParaTypeInPath(folder); 290 | return paraTypeOfFolder == paraType; 291 | } 292 | 293 | private findParaTypeInPath(folder: TFolder): ParaType | null { 294 | let type = this.getTypeFromName(folder.name); 295 | if (type === null && !folder.isRoot()) { 296 | type = this.findParaTypeInPath(folder.parent); 297 | } 298 | return type; 299 | } 300 | 301 | /** 302 | * 303 | * @param file 304 | * @returns the ParaType if found, returns null if not 305 | */ 306 | private findTopelevelParaTypeInPath(folder: TFolder): ParaType | null { 307 | let type = this.getTypeFromName(folder.name); 308 | if (!folder.isRoot()) { 309 | // always prioritize found type from parent to avoid nested folder issue 310 | let foundTypeInParent = this.findTopelevelParaTypeInPath( 311 | folder.parent 312 | ); 313 | if (foundTypeInParent != null) { 314 | type = foundTypeInParent; 315 | } 316 | } 317 | return type; 318 | } 319 | 320 | private async createParaFolders(): Promise { 321 | for (let foldername of this.folderMapping.values()) { 322 | await this.app.vault.createFolder(foldername); 323 | } 324 | } 325 | 326 | private isParaVault(): boolean { 327 | let neededFolders = this.folderMapping.values(); 328 | let root = this.app.vault.getRoot(); 329 | for (let i of neededFolders) { 330 | let found = root.children.find((elem) => i === elem.name); 331 | if (found === undefined) { 332 | return false; 333 | } 334 | } 335 | return true; 336 | } 337 | 338 | private createMetaHeader(): string { 339 | let today = moment().format(DATE_FORMAT); 340 | return `createdAt: ${today}\n\n---\n`; 341 | } 342 | 343 | private getDirName(path: string) { 344 | if (path.endsWith("/")) { 345 | // is already a path return 346 | return path; 347 | } 348 | let lastSlashIdx = path.lastIndexOf("/"); 349 | if (lastSlashIdx === -1) { 350 | // no slashes found 351 | throw new Error("No directory found in path"); 352 | } 353 | return path.slice(0, lastSlashIdx); 354 | } 355 | 356 | /** 357 | * Deletes given folder recursivly to the next para type if empty. 358 | * @param folder 359 | */ 360 | private async deleteFolderIfEmpty(folder: TFolder): Promise { 361 | // stop when meet PARA folder 362 | if (this.getTypeFromName(folder.name) !== null) { 363 | return; 364 | } 365 | if (folder.children.length === 0) { 366 | let folderToDelete = folder.parent; 367 | await this.app.vault.delete(folder); 368 | return this.deleteFolderIfEmpty(folderToDelete); 369 | } 370 | } 371 | 372 | private getTypeFromName(name: string): ParaType | null { 373 | for (let [key, val] of this.folderMapping.entries()) { 374 | if (name === val) { 375 | return key; 376 | } 377 | } 378 | return null; 379 | } 380 | } 381 | -------------------------------------------------------------------------------- /src/modals/new_entry_modal.ts: -------------------------------------------------------------------------------- 1 | import ParaShortcutsPlugin from "main"; 2 | import { App, FuzzySuggestModal} from "obsidian"; 3 | import { ParaType } from "para_types"; 4 | 5 | 6 | export class CreateNewEntryModal extends FuzzySuggestModal { 7 | 8 | plugin: ParaShortcutsPlugin; 9 | 10 | constructor(app: App, plugin: ParaShortcutsPlugin) { 11 | super(app); 12 | this.plugin = plugin; 13 | this.setPlaceholder("Create a new entry in:"); 14 | } 15 | 16 | onChooseItem(item: ParaType, evt: MouseEvent | KeyboardEvent): void { 17 | this.plugin.createEntryByType(item); 18 | } 19 | 20 | getItems(): ParaType[] { 21 | return [ParaType.projects, ParaType.areas_of_responsibility, ParaType.resources]; 22 | } 23 | 24 | getItemText(item: ParaType): string { 25 | return item; 26 | } 27 | 28 | } 29 | -------------------------------------------------------------------------------- /src/para/project.ts: -------------------------------------------------------------------------------- 1 | export const PROJECT_TEMPLATE = ` 2 | # 3 | tags: 4 | createdAt: 5 | dueAt: 6 | `; -------------------------------------------------------------------------------- /src/para_types.ts: -------------------------------------------------------------------------------- 1 | export enum ParaType { 2 | projects = "Projects", 3 | areas_of_responsibility = "Areas of Responsibility", 4 | resources = "Resources", 5 | archive = "Archive" 6 | } 7 | -------------------------------------------------------------------------------- /src/settings/settings.ts: -------------------------------------------------------------------------------- 1 | import { ParaType } from "para_types"; 2 | 3 | export interface Settings { 4 | folders: { 5 | project: string, 6 | area: string, 7 | resource: string, 8 | archive: string 9 | }, 10 | } 11 | 12 | export const DEFAULT_SETTINGS: Settings = { 13 | folders: { 14 | project: "1-Projects", 15 | area: "2-Areas", 16 | resource: "3-Resources", 17 | archive: "4-Archive", 18 | } 19 | }; 20 | 21 | /** 22 | * Convert a settings-object to a map with ParaType keys. 23 | */ 24 | export function settingsToMap(settings: Settings) { 25 | return new Map([ 26 | [ParaType.projects, settings.folders.project], 27 | [ParaType.areas_of_responsibility, settings.folders.area], 28 | [ParaType.resources, settings.folders.resource], 29 | [ParaType.archive, settings.folders.archive] 30 | ]); 31 | } -------------------------------------------------------------------------------- /src/settings/settings_tab.ts: -------------------------------------------------------------------------------- 1 | import ParaShortcutsPlugin from "main"; 2 | import { App, PluginSettingTab, Setting } from "obsidian"; 3 | import { ParaType } from "para_types"; 4 | 5 | export class ParaShortcutsSettingTab extends PluginSettingTab { 6 | plugin: ParaShortcutsPlugin; 7 | 8 | constructor(app: App, plugin: ParaShortcutsPlugin) { 9 | super(app, plugin); 10 | this.plugin = plugin; 11 | } 12 | 13 | display(): void { 14 | const { containerEl } = this; 15 | 16 | containerEl.empty(); 17 | 18 | containerEl.createEl('h2', { text: 'Settings for PARA-Shortcuts.' }); 19 | 20 | new Setting(containerEl) 21 | .setName('Project folder') 22 | .setDesc('the folder name for your "Projects"') 23 | .addText(text => text 24 | .setPlaceholder('eg. Projects') 25 | .setValue(this.plugin.settings.folders.project) 26 | .onChange(async (value) => { 27 | this.plugin.settings.folders.project = value; 28 | await this.plugin.saveSettings(); 29 | })); 30 | new Setting(containerEl) 31 | .setName('Area of Resposibility folder') 32 | .setDesc('the folder name for your "Area of Resposibility"') 33 | .addText(text => text 34 | .setPlaceholder('eg. Area') 35 | .setValue(this.plugin.settings.folders.area) 36 | .onChange(async (value) => { 37 | this.plugin.settings.folders.area = value; 38 | await this.plugin.saveSettings(); 39 | })); 40 | new Setting(containerEl) 41 | .setName('Resources folder') 42 | .setDesc('the folder name for your "Resources"') 43 | .addText(text => text 44 | .setPlaceholder('eg. Resources') 45 | .setValue(this.plugin.settings.folders.resource) 46 | .onChange(async (value) => { 47 | this.plugin.settings.folders.resource = value; 48 | await this.plugin.saveSettings(); 49 | })); 50 | new Setting(containerEl) 51 | .setName('Archive folder') 52 | .setDesc('the folder name for your "Archive"') 53 | .addText(text => text 54 | .setPlaceholder('eg. Archive') 55 | .setValue(this.plugin.settings.folders.archive) 56 | .onChange(async (value) => { 57 | this.plugin.settings.folders.archive = value; 58 | await this.plugin.saveSettings(); 59 | })); 60 | } 61 | } 62 | -------------------------------------------------------------------------------- /styles.css: -------------------------------------------------------------------------------- 1 | /* Sets all the text color to red! */ 2 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "baseUrl": "src", 4 | "inlineSourceMap": true, 5 | "inlineSources": true, 6 | "module": "ESNext", 7 | "target": "ES6", 8 | "allowJs": true, 9 | "noImplicitAny": true, 10 | "moduleResolution": "node", 11 | "importHelpers": true, 12 | "lib": [ 13 | "DOM", 14 | "ES5", 15 | "ES6", 16 | "ES7" 17 | ] 18 | }, 19 | "include": [ 20 | "src/**/*.ts", 21 | "test/**/*.ts" 22 | ] 23 | } 24 | -------------------------------------------------------------------------------- /versions.json: -------------------------------------------------------------------------------- 1 | { 2 | "1.0.7": "0.9.12", 3 | "1.0.6": "0.9.12", 4 | "1.0.5": "0.9.12", 5 | "1.0.4": "0.9.12", 6 | "1.0.3": "0.9.12", 7 | "1.0.2": "0.9.12", 8 | "1.0.1": "0.9.12", 9 | "0.0.0": "0.9.7" 10 | } 11 | --------------------------------------------------------------------------------