Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for outdenting string arguments. #8

Merged
merged 14 commits into from
Mar 17, 2018
Merged

Add support for outdenting string arguments. #8

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
d5df3bf
Add support for outdenting string arguments.
treshugart Mar 12, 2018
3853611
Get API working but breaking because types.
treshugart Mar 13, 2018
3b5ecd2
Unclobbers trailing whitespace in tests
cspotcode Mar 13, 2018
f07cb40
Proper typings for `extend` function
cspotcode Mar 13, 2018
59cbef1
Fix type info for new `string()` method
cspotcode Mar 13, 2018
95a380a
Add docs for new `string` method to README
cspotcode Mar 13, 2018
9edb8d5
Merge branch 'master' into outdent-string
cspotcode Mar 13, 2018
8fe3b5a
run code formatter
cspotcode Mar 13, 2018
9d7eaa6
Merge branch 'master' into outdent-string
cspotcode Mar 17, 2018
67e3800
Travis CI improvements: use `npm ci` and test on node lts and stable …
cspotcode Mar 17, 2018
7065873
Upgrade TypeScript
cspotcode Mar 17, 2018
e3a83e5
Add `node_modules` caching to Travis
cspotcode Mar 17, 2018
c2c5f3b
Fix type error
cspotcode Mar 17, 2018
e7925ee
Fix bash syntax in travis.yml
cspotcode Mar 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,10 @@ function createInstance(options: Options): Outdent {
}
}

(outdent as any).string = (str: string): string => {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will currently be breaking the build. I have absolutely no idea how to type this in TS. Halp.

Copy link
Contributor Author

@treshugart treshugart Mar 13, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm use Flow a bit, so my TS knowledge is limited. Basically, what I want to express is something like this: https://flow.org/try/#0PQKgBAAgZgNg9gdzCYAoVUCuA7AxgFwEs5sxcAnAUwEN9KAKa8gcwC4wAjOOGG7ASnYBnfOULZmYAD5gAKpRFgA3qjBhCUMIxb9lqsAEgq+TOVIBycwG59AX324SiuooC8W3a4B8YSzbUu+AB0ALaU+AAWcAAmYO70nj5++sampIE29qj4AJ4ADpRgAGKk8YlgImIS2fmF8m7FpABkemphkTHsJai2NkA.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No worries, I'll make a commit to fix the types.

type Fn = () => string;
type Test = Fn & {
  method: Fn
};

That actually works in TypeScript; it was just balking at augmenting a function without first declaring the extended interface. (outdent as Outdent).string = does the trick.

One of these days I'll learn some Flow.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, that would explain my confusion then. So close!

return _outdent([str], [], outdent, options);
};

return outdent;
}

Expand Down
23 changes: 15 additions & 8 deletions test/spec/spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ function makeStrings(...strings: Array<string>): TemplateStringsArray {
}

describe('outdent', () => {

it('Removes indentation', () => {
expect(outdent`
Hello
Expand Down Expand Up @@ -35,7 +34,7 @@ describe('outdent', () => {
expect(outdent`
Hello
World

`).to.equal('Hello\nWorld\n');
});

Expand All @@ -62,15 +61,15 @@ removed
`).to.equal('Hello\n\nWorld');
expect(outdent`
Hello

World
`).to.equal('Hello\n\nWorld');
});

it('Preserves trailing spaces on blank lines', () => {
expect(outdent`
Hello

World
`).to.equal('Hello\n \nWorld');
});
Expand All @@ -94,7 +93,7 @@ removed
`).to.equal('5678');

expect(od`

${ od }
12345678
`).to.equal('5678');
Expand Down Expand Up @@ -153,7 +152,6 @@ removed
Hello
World
`).to.equal('Hello\nWorld\n');

});
it('Does not trim trailing nor leading newline when asked not to', () => {
expect(outdent({
Expand All @@ -174,14 +172,14 @@ removed
trimLeadingNewline: false,
trimTrailingNewline: false,
}) `

`).to.equal('\n\n');
});

it('Merges options objects', () => {
const customOutdent = outdent({ trimLeadingNewline: false })({ trimTrailingNewline: false });
expect(customOutdent`

`).to.equal('\n\n');

expect(customOutdent({ trimLeadingNewline: true }) `
Expand Down Expand Up @@ -215,4 +213,13 @@ removed
expect(outdent`Hello world!
`).to.equal('Hello world!');
});

it('outdent.string takes strings as input and formats them', () => {
expect(
outdent.string(`
Hello world!
Hello world!
`)
).to.equal('Hello world!\n Hello world!');
});
});
5 changes: 5 additions & 0 deletions test/ts/usage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,8 @@ const newOutdent2 = newOutdent1({ trimLeadingNewline: false });
s = newOutdent2`
hello ${ 123 } world`;
const outdent2: Outdent = newOutdent2;
s = outdent.string(`
bar
baz
qux
`);