TypeScript icon indicating copy to clipboard operation
TypeScript copied to clipboard

Adds optional indentation parameter to createPrinter (in emitter.ts) to allow spe…

Open ajesshope opened this issue 3 years ago • 10 comments

…cifying the indentation either as a number of spaces or a sequence of characters (be that tab(s) or any other character(s) of choice).

How this works? Currently the indentation is hardcoded in the utilities.ts (called indentStrings) as a cached array of strings where each string in the array is the next step of indentation to be used... position 0 = "", 1 = "....", 2 = "........", etc. (. = space) ... and it cannot be changed. The modifications in this pull request includes a method that will 'rebuild' the content of that array using the information provided by a new PrinterOptions property called 'indentation'. Note: the array is the same instance... just the content changes.

If 'indentation' is not supplied (the default (and also fully backwards compatiable) or is not a string or number) then the cached array is left as is. If 'indentation' is a number between 0 to 9 (negative numbers or numbers higher than 9 are treated as a default of 4) then the cached array content is rebuilt with strings incremented in each subsequent position with the supplied number of spaces... e.g. 3 = ["", "...", "......", etc] (once again . = space) if 'indentation' is a string then the cached array content is rebuilt with that string as the indentation step... "\t" = ["", "\t", "\t\t", etc]

Special note: The current implementation of the indentation is a 'static' cached array (all createPrinter instances use the same array). It is possible to see unexpected results when 2 or more instances of a printer are created in parallel (and the indentation is different). The latest createPrinter call will dictate the size and content of each indentation step at the time of the call. This can only be fixed by moving the indentation cache into the 'printer' instance and is beyond the scope of this pull request.

Fixes https://github.com/microsoft/TypeScript/issues/2306 .

ajesshope avatar Sep 20 '22 07:09 ajesshope

This PR doesn't have any linked issues. Please open an issue that references this PR. From there we can discuss and prioritise.

typescript-bot avatar Sep 20 '22 07:09 typescript-bot

CLA assistant check
All CLA requirements met.

ghost avatar Sep 20 '22 07:09 ghost

I'm curious about the performance implications.

MartinJohns avatar Sep 20 '22 07:09 MartinJohns

The array content is changed (if there is a difference to the existing array content) at instantiation of the printer (aka createPrinter)... so should be very minimal if any at all.

ajesshope avatar Sep 20 '22 07:09 ajesshope

This PR doesn't have any linked issues. Please open an issue that references this PR. From there we can discuss and prioritise.

This pull request addresses open issue #2306

How is this not a link to the issue the PR fixes? Is the wording wrong? A little direction would be greatly appreciated :)

ajesshope avatar Oct 04 '22 14:10 ajesshope

It would have to be written like "Fixes #2306" to be recognized; your PR has it empty at the bottom.

jakebailey avatar Oct 07 '22 05:10 jakebailey

The TypeScript team hasn't accepted the linked issue #2306. If you can get it accepted, this PR will have a better chance of being reviewed.

typescript-bot avatar Oct 09 '22 12:10 typescript-bot

The TypeScript team hasn't accepted the linked issue #2306. If you can get it accepted, this PR will have a better chance of being reviewed.

typescript-bot avatar Oct 09 '22 12:10 typescript-bot

It would have to be written like "Fixes #2306" to be recognized; your PR has it empty at the bottom.

Ahh I see it now... i missed that... thank you.

ajesshope avatar Oct 09 '22 12:10 ajesshope

Any ideas on why the license/cla is saying "Queued — Contributor License Agreement is not agreed yet."... this PR's "Conversations" tab is clearly showing it signed 20 days ago. Also on the "Checks" tab the link to the Contributor License Agreement is returning a 404 Page Not Found

ajesshope avatar Oct 10 '22 05:10 ajesshope

@microsoft-github-policy-service agree [company="Rocket Software Pty Ltd"]

From: microsoft-github-policy-service[bot] @.> Sent: Sunday, 23 October 2022 9:18 PM To: microsoft/TypeScript @.> Cc: Adrian Jesshope @.>; Mention @.> Subject: Re: [microsoft/TypeScript] Adds optional indentation parameter to createPrinter (in emitter.ts) to allow spe… (PR #50855)

EXTERNAL EMAIL

@ajesshopehttps://github.com/ajesshope please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer. Contributor License Agreement Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below.

  1. Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, that is delivered by You to Microsoft under this Agreement. “Project” means any of the projects owned or managed by Microsoft and offered under a license approved by the Open Source Initiative (www.opensource.orghttp://www.opensource.org). “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any Project, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of discussing and improving that Project, but excluding communication that is conspicuously marked or otherwise designated in writing by You as “Not a Submission.” “Submission” means the Code and any other copyrightable material Submitted by You, including any associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any Project. This Agreement covers any and all Submissions that You, now or in the future (except as described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work. Should You wish to Submit materials that are not Your original work, You may Submit them separately to the Project if You (a) retain all copyright and license information that was in the materials as You received them, (b) in the description accompanying Your Submission, include the phrase “Submission containing materials of a third party:” followed by the names of the third party and any licenses or other restrictions of which You are aware, and (c) follow any other instructions in the Project’s written guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your Submission is made in the course of Your work for an employer or Your employer has intellectual property rights in Your Submission by contract or applicable law, You must secure permission from Your employer to make the Submission before signing this Agreement. In that case, the term “You” in this Agreement will refer to You and the employer collectively. If You change employers in the future and desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under Your patent claims that are necessarily infringed by the Submission or the combination of the Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above licenses. You represent that each of Your Submissions is entirely Your original work (except as You may have disclosed under Section 3). You represent that You have secured permission from Your employer to make the Submission in cases where Your Submission is made in the course of Your work for Your employer or Your employer has intellectual property rights in Your Submission by contract or applicable law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You have the necessary authority to bind the listed employer to the obligations contained in this Agreement. You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which You later become aware that would make Your representations in this Agreement inaccurate in any respect.
  3. Information about Submissions. You agree that contributions to Projects and information about contributions may be maintained indefinitely and disclosed publicly, including Your name and other information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County, Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and supersedes any and all prior agreements, understandings or communications, written or oral, between the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

— Reply to this email directly, view it on GitHubhttps://github.com/microsoft/TypeScript/pull/50855#issuecomment-1288079126, or unsubscribehttps://github.com/notifications/unsubscribe-auth/A26WLUMBAZBUFREYO35J57DWEUGFTANCNFSM6AAAAAAQQYJQF4. You are receiving this because you were mentioned.Message ID: @.@.>>

================================ Rocket Software, Inc. and subsidiaries ■ 77 Fourth Avenue, Waltham MA 02451 ■ Main Office Toll Free Number: +1 855.577.4323 Contact Customer Support: https://my.rocketsoftware.com/RocketCommunity/RCEmailSupport Unsubscribe from Marketing Messages/Manage Your Subscription Preferences - http://www.rocketsoftware.com/manage-your-email-preferences Privacy Policy - http://www.rocketsoftware.com/company/legal/privacy-policy

This communication and any attachments may contain confidential information of Rocket Software, Inc. All unauthorized use, disclosure or distribution is prohibited. If you are not the intended recipient, please notify Rocket Software immediately and destroy all copies of this communication. Thank you.

ajesshope avatar Oct 23 '22 21:10 ajesshope

@microsoft-github-policy-service agree company="Rocket Software Pty Ltd"

From: microsoft-github-policy-service[bot] @.> Sent: Monday, 24 October 2022 8:54 AM To: microsoft/TypeScript @.> Cc: Adrian Jesshope @.>; Mention @.> Subject: Re: [microsoft/TypeScript] Adds optional indentation parameter to createPrinter (in emitter.ts) to allow spe… (PR #50855)

EXTERNAL EMAIL

@ajesshopehttps://github.com/ajesshope the command you issued was incorrect. Please try again.

Examples are:

@microsoft-github-policy-service agree

and

@microsoft-github-policy-service agree company="your company"

— Reply to this email directly, view it on GitHubhttps://github.com/microsoft/TypeScript/pull/50855#issuecomment-1288209396, or unsubscribehttps://github.com/notifications/unsubscribe-auth/A26WLUJIYCVVN4ACGW2UCFLWEWXX3ANCNFSM6AAAAAAQQYJQF4. You are receiving this because you were mentioned.Message ID: @.@.>>

================================ Rocket Software, Inc. and subsidiaries ■ 77 Fourth Avenue, Waltham MA 02451 ■ Main Office Toll Free Number: +1 855.577.4323 Contact Customer Support: https://my.rocketsoftware.com/RocketCommunity/RCEmailSupport Unsubscribe from Marketing Messages/Manage Your Subscription Preferences - http://www.rocketsoftware.com/manage-your-email-preferences Privacy Policy - http://www.rocketsoftware.com/company/legal/privacy-policy

This communication and any attachments may contain confidential information of Rocket Software, Inc. All unauthorized use, disclosure or distribution is prohibited. If you are not the intended recipient, please notify Rocket Software immediately and destroy all copies of this communication. Thank you.

ajesshope avatar Oct 23 '22 21:10 ajesshope